You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2013/12/11 11:27:21 UTC
svn commit: r1550097 - /qpid/site/README
Author: jross
Date: Wed Dec 11 10:27:20 2013
New Revision: 1550097
URL: http://svn.apache.org/r1550097
Log:
QPID-5311: Update the readme
- Remove the "wrinkle" section on current versus previous releases
- Add PyYAML to the list of script dependencies
- Remove some trailing whitespace
Modified:
qpid/site/README
Modified: qpid/site/README
URL: http://svn.apache.org/viewvc/qpid/site/README?rev=1550097&r1=1550096&r2=1550097&view=diff
==============================================================================
--- qpid/site/README (original)
+++ qpid/site/README Wed Dec 11 10:27:20 2013
@@ -42,7 +42,7 @@ These are the important ones:
transom$ make render
-3. To look at the result in your browser, navigate to
+3. To look at the result in your browser, navigate to
file:///$somepath/transom/output/somepage.html
@@ -101,26 +101,15 @@ for a new release.
# For new Qpid releases
transom$ make gen-release RELEASE=$VERSION
-
- # For new Qpid Proton releases
+
+ # For new Qpid Proton releases
transom$ make gen-proton-release RELEASE=$VERSION
-
+
These will produce a new tree of release content under
`input/releases/`. The content includes API docs, examples, and
books. Once generated, you can make any edits you'd like and check it
in.
-A wrinkle: the current-version release page should point to a mirror
-download URL, while all previous versions should point instead at dist
-URLs. To control which is generated, use the `CURRENT` parameter.
-
- transom$ make gen-release-page RELEASE=$CURRENT_VERSION CURRENT=1
-
-The superceded release (current minus one) should be regenerated with
-`CURRENT` set to `0` (the default).
-
- transom$ make gen-release-page RELEASE=$PREVIOUS_VERSION CURRENT=0
-
When you add release content, you should also update the following
files:
@@ -131,10 +120,10 @@ Run `make render` with `FORCE=1` after m
The scripts depend on the availability of the following tools in your
environment: cmake, dot, doxygen, epydoc, fop, gcc, javadoc, make,
-pygments, rdoc, and xsltproc. The following yum command works to
-install all the required dependencies on Fedora or RHEL.
+pygments, PyYAML, rdoc, and xsltproc. The following yum command works
+to install all the required dependencies on Fedora or RHEL.
- $ sudo yum install cmake doxygen epydoc fop graphviz java-devel make python-pygments rubygem-rdoc libxslt
+ $ sudo yum install cmake doxygen epydoc fop graphviz java-devel make python-pygments PyYAML rubygem-rdoc libxslt
## Publishing your work
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org