You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2019/11/13 00:12:53 UTC
[commons-rng] 04/07: Doxia: Remove nested block level elements.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 041adb6dee5e95344872ea641be2ada3252f6665
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Tue Nov 12 22:12:45 2019 +0000
Doxia: Remove nested block level elements.
This removes <ol> elements from inside <p> elements.
---
src/site/xdoc/developers.xml | 192 +++++++++++++++++++++----------------------
1 file changed, 95 insertions(+), 97 deletions(-)
diff --git a/src/site/xdoc/developers.xml b/src/site/xdoc/developers.xml
index 15c2f77..0378d9f 100644
--- a/src/site/xdoc/developers.xml
+++ b/src/site/xdoc/developers.xml
@@ -40,112 +40,110 @@
</p>
<subsection name="Contributing">
<p><strong>Getting Started</strong></p>
- <p>
- <ol>
- <li>
- Download the Commons RNG source code. Follow the instructions
- under the heading "Repository Checkout" on the
- <a href="https://gitbox.apache.org/">Git at the ASF page</a>.
- The git url for the current development sources of Commons RNG
- is <source>http://gitbox.apache.org/repos/asf/commons-rng.git</source>
- for anonymous read-only access and
- <source>https://apacheid@gitbox.apache.org/repos/asf/commons-rng.git</source>
- (where apacheid should be replaced by each committer Apache ID) for committers
- read-write access.
- </li>
- <li>
- Like most commons components, Commons RNG uses Apache Maven as our
- build tool. The sources can also be built using Ant (a working
- Ant build.xml is included in the top level project directory).
- To build Commons RNG using Maven, you can follow the instructions for
- <a href="http://maven.apache.org/run-maven/index.html">Building a
- project with Maven</a>.
- Launch Maven from the top-level directory
- in the checkout of Commons RNG trunk. No special setup is required,
- except that currently to build the site (i.e. to execute Maven's
- "site" goal), you may need to increase the default memory allocation
- (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
- Maven.
- </li>
- <li>
- Have a look at the new features that users and developers have requested
- on the <a href="http://wiki.apache.org/commons/RngWishList">
- RNG Wish List Wiki Page.</a>
- </li>
- <li>
- Be sure to join the commons-dev and commons-user
- <a href="mail-lists.html">
- email lists</a> and use them appropriately (make sure the string
- "[RNG]" starts the Subject line of all your postings).
- Make any proposals here where the group can comment on them.
- </li>
+ <ol>
+ <li>
+ Download the Commons RNG source code. Follow the instructions
+ under the heading "Repository Checkout" on the
+ <a href="https://gitbox.apache.org/">Git at the ASF page</a>.
+ The git url for the current development sources of Commons RNG
+ is <source>http://gitbox.apache.org/repos/asf/commons-rng.git</source>
+ for anonymous read-only access and
+ <source>https://apacheid@gitbox.apache.org/repos/asf/commons-rng.git</source>
+ (where apacheid should be replaced by each committer Apache ID) for committers
+ read-write access.
+ </li>
+ <li>
+ Like most commons components, Commons RNG uses Apache Maven as our
+ build tool. The sources can also be built using Ant (a working
+ Ant build.xml is included in the top level project directory).
+ To build Commons RNG using Maven, you can follow the instructions for
+ <a href="http://maven.apache.org/run-maven/index.html">Building a
+ project with Maven</a>.
+ Launch Maven from the top-level directory
+ in the checkout of Commons RNG trunk. No special setup is required,
+ except that currently to build the site (i.e. to execute Maven's
+ "site" goal), you may need to increase the default memory allocation
+ (e.g. <code>export MAVEN_OPTS=-Xmx512m</code>) before launching
+ Maven.
+ </li>
+ <li>
+ Have a look at the new features that users and developers have requested
+ on the <a href="http://wiki.apache.org/commons/RngWishList">
+ RNG Wish List Wiki Page.</a>
+ </li>
+ <li>
+ Be sure to join the commons-dev and commons-user
+ <a href="mail-lists.html">
+ email lists</a> and use them appropriately (make sure the string
+ "[RNG]" starts the Subject line of all your postings).
+ Make any proposals here where the group can comment on them.
+ </li>
+ <li>
+ <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
+ Setup an account on JIRA
+ </a>
+ and use it to submit patches and
+ identify bugs. Read the
+ <a href="https://issues.apache.org/bugwritinghelp.html">
+ directions</a>
+ for submitting bugs and search the database to
+ determine if an issue exists or has already been dealt with.
+ <p>
+ See the <a href="https://commons.apache.org/rng/issue-tracking.html">
+ Commons RNG Issue Tracking Page</a>
+ for more information on how to
+ search for or submit bugs or enhancement requests.
+ </p>
<li>
- <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">
- Setup an account on JIRA
- </a>
- and use it to submit patches and
- identify bugs. Read the
- <a href="https://issues.apache.org/bugwritinghelp.html">
- directions</a>
- for submitting bugs and search the database to
- determine if an issue exists or has already been dealt with.
- <p>
- See the <a href="https://commons.apache.org/rng/issue-tracking.html">
- Commons RNG Issue Tracking Page</a>
- for more information on how to
- search for or submit bugs or enhancement requests.
- </p>
- <li>
- Generating patches: The requested format for generating patches is
- the Unified Diff format, which can be easily generated using the git
- client or various IDEs.
- <source>git diff -p > patch </source>
- Run this command from the top-level project directory (where pom.xml
- resides).
- </li>
+ Generating patches: The requested format for generating patches is
+ the Unified Diff format, which can be easily generated using the git
+ client or various IDEs.
+ <source>git diff -p > patch </source>
+ Run this command from the top-level project directory (where pom.xml
+ resides).
</li>
- </ol>
- </p>
+ </li>
+ </ol>
<p><strong>Contributing ideas and code</strong></p>
<p>
Follow the steps below when making suggestions for additions or
enhancements to Commons RNG. This will make it easier for the community
to comment on your ideas and for the committers to keep track of them.
Thanks in advance!
- <ol>
- <li>Start with a post to the commons-dev mailing list, with [RNG] at
- the beginning of the subject line, followed by a short title
- describing the new feature or enhancement; for example, "[RNG]
- New cryptographically secure generator".
- The body of the post should include each of the following items
- (but be <strong>as brief as possible</strong>):
- <ul>
- <li>A concise description of the new feature / enhancement</li>
- <li>References to definitions and algorithms. Using standard
- definitions and algorithms makes communication much easier and will
- greatly increase the chances that we will accept the code / idea</li>
- <li>Some indication of why the addition / enhancement is practically
- useful</li>
- </ul></li>
- <li>Assuming a generally favorable response to the idea on commons-dev,
- the next step is to add an entry to the
- <a href="http://wiki.apache.org/commons/RngWishList">RNG Wish
- List</a> corresponding to the idea. Include a reference to the
- discussion thread. </li>
- <li>Create a JIRA ticket using the the feature title as the short
- description. Incorporate feedback from the initial posting in the
- description. Add a reference to the JIRA ticket to the WishList entry.
- </li>
- <li>Submit code as attachments to the JIRA ticket. Please use one
- ticket for each feature, adding multiple patches to the ticket
- as necessary. Use the git diff command to generate your patches as
- diffs. Please do not submit modified copies of existing java files. Be
- patient (but not <strong>too</strong> patient) with committers reviewing
- patches. Post a *nudge* message to commons-dev with a reference to the
- ticket if a patch goes more than a few days with no comment or commit.
- </li>
- </ol>
</p>
+ <ol>
+ <li>Start with a post to the commons-dev mailing list, with [RNG] at
+ the beginning of the subject line, followed by a short title
+ describing the new feature or enhancement; for example, "[RNG]
+ New cryptographically secure generator".
+ The body of the post should include each of the following items
+ (but be <strong>as brief as possible</strong>):
+ <ul>
+ <li>A concise description of the new feature / enhancement</li>
+ <li>References to definitions and algorithms. Using standard
+ definitions and algorithms makes communication much easier and will
+ greatly increase the chances that we will accept the code / idea</li>
+ <li>Some indication of why the addition / enhancement is practically
+ useful</li>
+ </ul></li>
+ <li>Assuming a generally favorable response to the idea on commons-dev,
+ the next step is to add an entry to the
+ <a href="http://wiki.apache.org/commons/RngWishList">RNG Wish
+ List</a> corresponding to the idea. Include a reference to the
+ discussion thread. </li>
+ <li>Create a JIRA ticket using the the feature title as the short
+ description. Incorporate feedback from the initial posting in the
+ description. Add a reference to the JIRA ticket to the WishList entry.
+ </li>
+ <li>Submit code as attachments to the JIRA ticket. Please use one
+ ticket for each feature, adding multiple patches to the ticket
+ as necessary. Use the git diff command to generate your patches as
+ diffs. Please do not submit modified copies of existing java files. Be
+ patient (but not <strong>too</strong> patient) with committers reviewing
+ patches. Post a *nudge* message to commons-dev with a reference to the
+ ticket if a patch goes more than a few days with no comment or commit.
+ </li>
+ </ol>
</subsection>
<subsection name='Coding Style'>