You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ka...@apache.org on 2016/02/20 17:47:50 UTC
[1/4] mesos git commit: Updated release guide to include doxygen site
generation.
Repository: mesos
Updated Branches:
refs/heads/master 1488f16d2 -> 67e77fd52
Updated release guide to include doxygen site generation.
Review: https://reviews.apache.org/r/43318
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/67e77fd5
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/67e77fd5
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/67e77fd5
Branch: refs/heads/master
Commit: 67e77fd52d3c02f77e68f80d8baa0a5bdccd5e87
Parents: 292ce3d
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Sun Feb 7 19:25:52 2016 -0500
Committer: Kapil Arya <ka...@mesosphere.io>
Committed: Sat Feb 20 11:46:55 2016 -0500
----------------------------------------------------------------------
docs/release-guide.md | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/67e77fd5/docs/release-guide.md
----------------------------------------------------------------------
diff --git a/docs/release-guide.md b/docs/release-guide.md
index a0d27cb..f0963e7 100644
--- a/docs/release-guide.md
+++ b/docs/release-guide.md
@@ -172,15 +172,18 @@ This guide describes the process of doing an official release of Mesos.
## Updating the website
1. After a successful release, please update the website pointing to the new release.
- See our [website README](http://svn.apache.org/repos/asf/mesos/site/) and
+ See our [website README](https://github.com/apache/mesos/blob/master/site/README.md/) and
the general [Apache project website guide](https://www.apache.org/dev/project-site.html)
for details on how to build and publish the website.
$ svn co https://svn.apache.org/repos/asf/mesos/site mesos-site
-2. Write a blog post announcing the new release and its features and major bug fixes.
+2. Update doxygen and javadoc pages for the website. For more information, see
+ [website README](https://github.com/apache/mesos/blob/master/site/README.md/).
-3. Update the Getting Started guide to use the latest release link.
+3. Write a blog post announcing the new release and its features and major bug fixes.
+
+4. Update the Getting Started guide to use the latest release link.
## Remove old releases from svn
[2/4] mesos git commit: Remove markdown files from doxygen.
Posted by ka...@apache.org.
Remove markdown files from doxygen.
* The doxygen html pages corresponding to doc/* markdown files are
redundant and have broken links. As such, they don't serve any
reasonable purpose in doxygen site.
* Also updated the main page to include direct links to libprocess/stout
developer guides.
* Updated site/README.md to include instructions for updating doxygen
and javadocs pages.
Review: https://reviews.apache.org/r/43319
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/52857aca
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/52857aca
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/52857aca
Branch: refs/heads/master
Commit: 52857acac781b84b003a6f1fdc69cb640bd361da
Parents: af14c38
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Tue Feb 2 18:59:18 2016 -0500
Committer: Kapil Arya <ka...@mesosphere.io>
Committed: Sat Feb 20 11:46:55 2016 -0500
----------------------------------------------------------------------
Doxyfile | 3 +--
site/README.md | 11 +++++++++++
src/main.dox | 9 +++------
3 files changed, 15 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/52857aca/Doxyfile
----------------------------------------------------------------------
diff --git a/Doxyfile b/Doxyfile
index d6dcb6b..779a8ea 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -576,7 +576,6 @@ WARN_LOGFILE =
INPUT = ../include/ ../src/ \
../3rdparty \
- ../docs \
../src/main.dox
# This tag can be used to specify the character encoding of the source files
@@ -594,7 +593,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
-FILE_PATTERNS = *.h *.hpp *.md
+FILE_PATTERNS = *.h *.hpp
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
http://git-wip-us.apache.org/repos/asf/mesos/blob/52857aca/site/README.md
----------------------------------------------------------------------
diff --git a/site/README.md b/site/README.md
index 78609fb..eb90a86 100644
--- a/site/README.md
+++ b/site/README.md
@@ -21,6 +21,17 @@ files within the source folder.
../support/generate-help-site.py
rake
+The doxygen and javadoc pages must be generated _after_ running `rake`.
+
+### Generating doxygen pages
+Doxygen pages can be generated using:
+
+ rake doxygen
+
+### Generating javadoc pages
+Javadoc pages can be generated using:
+
+ rake javadoc
## Development
To live edit the site run `rake dev` and then open a browser window to
http://git-wip-us.apache.org/repos/asf/mesos/blob/52857aca/src/main.dox
----------------------------------------------------------------------
diff --git a/src/main.dox b/src/main.dox
index d5b29cf..a6765f6 100644
--- a/src/main.dox
+++ b/src/main.dox
@@ -3,10 +3,7 @@
*
* The following Apache Mesos API documention is part of the overall [Apache Mesos documenation](http://mesos.apache.org/documentation/latest/).
*
- * @section style-guide Style Guide
- * * [Style Guide](http://mesos.apache.org/documentation/latest/mesos-c++-style-guide/) for adding and updating doxygen documentation.
- *
- * @section user-guide User Guides
- * * [Libprocess User Guide](http://mesos.apache.org/api/latest/c++/md_3rdparty_libprocess_README.html)
- * * [Stout User Guide](http://mesos.apache.org/api/latest/c++/md_3rdparty_libprocess_3rdparty_stout_README.html)
+ * @section developer-guide Developer Guides
+ * * [Libprocess developer guide](https://github.com/apache/mesos/blob/master/3rdparty/libprocess/README.md/)
+ * * [Stout developer guide](https://github.com/apache/mesos/blob/master/3rdparty/libprocess/3rdparty/stout/README.md/)
*/
[4/4] mesos git commit: Updated Doxyfile to use relative path.
Posted by ka...@apache.org.
Updated Doxyfile to use relative path.
By default, doxygen generated html pages use absolute path for links
(due to FULL_PATH_NAMES flag set to 'yes'). Thus the links break when
these pages are moved to a different directory. The fix is to ask
doxygen to strip out '/path/to/mesos/' from the generated links.
Review: https://reviews.apache.org/r/43382
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/af14c386
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/af14c386
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/af14c386
Branch: refs/heads/master
Commit: af14c3862f7f4167764452d0c41246b49022e8b2
Parents: 1488f16
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Tue Feb 9 16:04:59 2016 -0500
Committer: Kapil Arya <ka...@mesosphere.io>
Committed: Sat Feb 20 11:46:55 2016 -0500
----------------------------------------------------------------------
Doxyfile | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/af14c386/Doxyfile
----------------------------------------------------------------------
diff --git a/Doxyfile b/Doxyfile
index 1b0a2be..d6dcb6b 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -114,7 +114,13 @@ FULL_PATH_NAMES = YES
# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH =
+# Since we are setting FULL_PATH_NAMES, we should strip out '/path/to/mesos/'.
+# Otherwise, the html links also contain '/path/to/mesos/' and aren't relative.
+# We use '../' here because this file is invoked from within the 'site/'
+# directory as `doxygen -f ../Doxyfile` and thus the value '../' is equivalent
+# to specifying '/path/to/mesos/'.
+
+STRIP_FROM_PATH = ../
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
[3/4] mesos git commit: Updated doxygen target for site/Rakefile.
Posted by ka...@apache.org.
Updated doxygen target for site/Rakefile.
There are three components to generating new doxygen pages:
1. Now that we have a Doxyfile, pass it to `doxygen` command.
2. Genarate doxygen pages in a diretcory named `doxygen` in the current
directory.
3. Once the doxygen pages have been generated, move them into
`publish/api/latest/c++`.
After step 3, one can copy over the publish directory to mesos-site svn
repository.
Review: https://reviews.apache.org/r/43122
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/292ce3de
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/292ce3de
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/292ce3de
Branch: refs/heads/master
Commit: 292ce3de8566a49cf945006dc3c9da7cbae133f6
Parents: 52857ac
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Tue Feb 2 19:08:22 2016 -0500
Committer: Kapil Arya <ka...@mesosphere.io>
Committed: Sat Feb 20 11:46:55 2016 -0500
----------------------------------------------------------------------
site/Rakefile | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/292ce3de/site/Rakefile
----------------------------------------------------------------------
diff --git a/site/Rakefile b/site/Rakefile
index 10817d4..fbf690f 100644
--- a/site/Rakefile
+++ b/site/Rakefile
@@ -77,7 +77,9 @@ end
desc "Generate doxygen from the C++ source files in the codebase"
task :doxygen do
- system("pushd .. && doxygen && popd && rsync -avz ../docs/html/* publish/api/latest/c++")
+ FileUtils.rm_rf(Dir.glob("publish/api/latest/c++"))
+ FileUtils.mkdir_p("publish/api/latest")
+ system("doxygen ../Doxyfile && mv doxygen/html publish/api/latest/c++ && rm -rf doxygen")
end
desc "Run the site in development mode. Preview available at http://localhost:4567/"