[ 
https://issues.apache.org/jira/browse/HADOOP-12130?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14624116#comment-14624116
 ] 

Sean Busbey commented on HADOOP-12130:
--------------------------------------

{code}
+## Command Arguments
 
+test-patch always passes --batch-mode to maven to force it into 
non-interactive mode.  Additionally, some tests will also force -fae in order 
to get all of messages/errors during that mode.  It *does not* pass 
-DskipTests.  Additionally arguments should be handled either via the 
personality.
+
{code}

the last sentence's "Additionally" should be "Additional". The "either" looks 
superfluous, I think?

{code}
-    HINT: It is recommend to make the pluginname relatively small, 10 
characters at the most.  Otherwise the ASCII output table may be skewed.
+    HINT: It is recommend to make the pluginname relatively small, 10 
characters at the most.  Otherwise, the ASCII output table may be skewed.
{code}

consider "HINT: We recommend you make the ..."

{code}
+
+* BUILD\_NATIVE will be set to true if the system has requested that JNI code 
be built.
+
{code}

this is probably a topic for later, but what if we're running a C/C++ project 
in Maven? would that just always have BUILD_NATIVE? Should this say something 
like "has requested non-Java code" or is it specifically looking for JNI 
bindings?

{code}
+
+* CHANGED\_FILES is a list of all files that appear to be add, deleted, or 
modified in the patch.
+
{code}

added

{code}
+
+* HOW\_TO\_CONTRIBUTE should be a URL that points to a project's patch naming 
guidelines.  This is useful to set in personalities.
+
{code}

"... should be a URL that points to a project's on-boarding documentation for 
new users. Currently, we'll use it to suggest a review of patch naming 
guidelines. Since this should be project specific information, it is useful to 
set in your project's personality."

{code}
-The `--dirty-workspace` flag tells test-patch that the repository is not clean 
and it is ok to continue.  This version command does not run the unit tests.
+The `--dirty-workspace` flag tells test-patch that the repository is not clean 
and it is ok to continue.  This version of the command does not run the unit 
tests.
 
-To do that, we need to provide the --run-tests command:
+To do that, we need to provide the --run-tests option:
{code}

nit: "... does not run the unit tests by default." might be a little smoother 
on the transition.

{code}
 ```bash
 $ cd <workrepo>
-$ git diff --no-prefix trunk > /tmp/patchfile
+$ git diff --no-prefix master > /tmp/patchfile
 $ cd ../<testrepo>
 $ <workrepo>/dev-support/test-patch.sh --basedir=<testrepo> --resetrepo 
/tmp/patchfile
 ```
 {code}

nit: --no-prefix is bad and we shouldn't encourage people to use it.

{code}
+## Project Method
+
+However, test-patch can detect if it is a personality that is in it's 
"personality" directory based upon the project name:
+
+```bash
+$ test-patch.sh (other options) --project=(project)
+```
{code}

"it's" -> "its"

{code}
+# MultiJDK
+
+For many projects, it is useful to test Java code against multiple versions of 
JDKs at the same time.  test-patch can do this with the -multijdkdirs option:
+
+```bash
+$ test-patch.sh (other options) --multijdkdirs="/j/d/k/1,/j/d/k/2"
+```
+
+Not all Java tests support this mode, but those that do will now run their 
tests with all of the given versions of Java consecutively.  Tests that do not 
support MultiJDK mode (e.g., checkstyle) will use JAVA\_HOME.
+
+NOTE: JAVA\_HOME is always appended to the list of JDKs in MultiJDK mode.  If 
JAVA\_HOME is in the list, it will be moved to the end.
+
{code}

Is "javac" considered a test? if not, what version gets used to build the 
classes? to do the install step?



> document features added in 12113
> --------------------------------
>
>                 Key: HADOOP-12130
>                 URL: https://issues.apache.org/jira/browse/HADOOP-12130
>             Project: Hadoop Common
>          Issue Type: Sub-task
>          Components: yetus
>    Affects Versions: HADOOP-12111
>            Reporter: Allen Wittenauer
>            Assignee: Allen Wittenauer
>         Attachments: HADOOP-12130.HADOOP-12111.00.patch
>
>
> We need to write up more documentation, especially around the new stuff added 
> in 12113, since a lot of people are looking for information on those bits.  
> (e.g., "How do I use multiJDK mode?")



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to