impala-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jruss...@apache.org
Subject incubator-impala git commit: Correction to command syntax, from Laurel.
Date Mon, 07 Nov 2016 20:34:49 GMT
Repository: incubator-impala
Updated Branches:
  refs/heads/doc_prototype a0ea2c57c -> fe91c7dcb


Correction to command syntax, from Laurel.


Project: http://git-wip-us.apache.org/repos/asf/incubator-impala/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-impala/commit/fe91c7dc
Tree: http://git-wip-us.apache.org/repos/asf/incubator-impala/tree/fe91c7dc
Diff: http://git-wip-us.apache.org/repos/asf/incubator-impala/diff/fe91c7dc

Branch: refs/heads/doc_prototype
Commit: fe91c7dcb28e6b1deca88cd14fc17b3a8e93e0c0
Parents: a0ea2c5
Author: John Russell <jrussell@cloudera.com>
Authored: Mon Nov 7 12:34:41 2016 -0800
Committer: John Russell <jrussell@cloudera.com>
Committed: Mon Nov 7 12:34:41 2016 -0800

----------------------------------------------------------------------
 docs/generatingImpalaDoc.md | 36 ++++++++++++++++++------------------
 1 file changed, 18 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/fe91c7dc/docs/generatingImpalaDoc.md
----------------------------------------------------------------------
diff --git a/docs/generatingImpalaDoc.md b/docs/generatingImpalaDoc.md
index a4f5cc5..5021e39 100644
--- a/docs/generatingImpalaDoc.md
+++ b/docs/generatingImpalaDoc.md
@@ -15,35 +15,35 @@ Make sure that you have a recent version of a Java JDK installed and that
your J
    
    [https://github.com/dita-ot/dita-ot/releases/download/2.3.3/dita-ot-2.3.3.zip] (https://github.com/dita-ot/dita-ot/releases/download/2.3.3/dita-ot-2.3.3.zip)
    
-  **Note:** A DITA-OT 2.3.3 User Guide is included in the <code>doc</code> directory
when you extract the DITA-OT2.3.3 compressed file. Look for <code>userguide.pdf</code>
in the <code>doc</code> directory of the toolkit. For example, if you extract
the toolkit package to the <code>/Users/_\<username\>_/DITA-OT</code directory
on Mac OS, you will find the <code>userguide.pdf</code> at the following location:
+  **Note:** A DITA-OT 2.3.3 User Guide is included in the toolkit. Look for <code>userguide.pdf</code>
in the <code>doc</code> directory of the toolkit after you extract it. For example,
if you extract the toolkit package to the <code>/Users/\<_username_\>/DITA-OT</code>
directory on Mac OS, you will find the <code>userguide.pdf</code> at the following
location:
   
-  <code>/Users/_\<username\>_/DITA-OT/doc/userguide.pdf</code>
+  <code>/Users/\<_username_\>/DITA-OT/doc/userguide.pdf</code>
 
 ##To generate HTML or PDF:
 
 1. In the directory where you cloned the Impala documentation files, you will find the following
important configuration files in the <code>docs</code> subdirectory. These files
are used to convert the XML source you downloaded from the Apache site to PDF and HTML:
     * <code>impala.ditamap</code>: Tells the DITA Open Toolkit what topics to
include in the Impala User/Administration Guide. This guide also includes the Impala SQL Reference.
-    * <code>impala_sqlref.ditamap</code>: Tells the DITA Open Toolkit what topics
to include in the Impala SQL Reference.
+    * <code>impala\_sqlref.ditamap</code>: Tells the DITA Open Toolkit what topics
to include in the Impala SQL Reference.
     * <code>impala\_html.ditaval</code>: Further defines what topics to include
in the Impala HTML output.
-    * <code>impala_pdf.ditaval</code>: Further defines what topics to include
in the Impala PDF output.
+    * <code>impala\_pdf.ditaval</code>: Further defines what topics to include
in the Impala PDF output.
 2. Extract the contents of the DITA-OT package into a directory where you want to generate
the HTML or the PDF.
 3. Open a terminal window and navigate to the directory where you extracted the DITA-OT package.
 4.  Run one of the following commands, depending on what you want to generate:
-    * **To generate HTML output of the Impala User and Administration Guide, run the following
command:**
+    * **To generate HTML output of the Impala User and Administration Guide, which includes
the Impala SQL Reference, run the following command:**
     
-        <code>./bin/dita -input _\<path\_to\__impala.ditamap\> -format html5
-output _\<path\_to\_build\_output\_directory\>_ -filter _\<path\_to\__impala\_html.ditaval\></code>
+        <code>./bin/dita -input \<path\_to\_impala.ditamap\> -format html5 -output
\<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_html.ditaval\></code>
      
-     * **To generate PDF output of the Impala User and Administration Guide, run the following
command:**
+    * **To generate PDF output of the Impala User and Administration Guide, which includes
the Impala SQL Reference, run the following command:**
      
-        <code>./bin/dita -input _\<path\_to\__impala.ditamap\> -format pdf -output
_\<path\_to\_build\_output\_directory\>_ -filter _\<path\_to\__impala\_pdf.ditaval\></code>
+        <code>./bin/dita -input \<path\_to\_impala.ditamap\> -format pdf -output
\<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_pdf.ditaval\></code>
         
-     * **To generate HTML output of the Impala SQL Reference, run the following command:**
+    * **To generate HTML output of the Impala SQL Reference, run the following command:**
      
-        <code>./bin/dita -input _\<path\_to\__impala\_sqlref.ditamap\> -format
html5 -output _\<path\_to\_build\_output\_directory\>_ -filter _\<path\_to\__impala\_html.ditaval\></code>
+        <code>./bin/dita -input \<path\_to\_impala\_sqlref.ditamap\> -format
html5 -output \<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_html.ditaval\></code>
      
-     * **To generate PDF output of the Impala SQL Reference, run the following command:**
+    * **To generate PDF output of the Impala SQL Reference, run the following command:**
      
-        <code>./bin/dita -input _\<path\_to\__impala\_sqlref.ditamap\> -format
pdf -output _\<path\_to\_build\_output\_directory\>_ -filter _\<path\_to\__impala\_pdf.ditaval\></code>
+        <code>./bin/dita -input \<path\_to\_impala\_sqlref.ditamap\> -format
pdf -output \<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_pdf.ditaval\></code>
 
     **Note:** For a description of all command-line options, see the _DITA Open Toolkit User
Guide_ in the <code>doc</code> directory of your downloaded DITA Open Toolkit.
  
@@ -55,19 +55,19 @@ Make sure that you have a recent version of a Java JDK installed and that
your J
 
 Set your JAVA\_HOME environment variable to tell your computer where to find the Java executable
file. For example, to set your JAVA\_HOME environment on Mac OS X when you the the 1.8.0\_101
version of the Java Development Kit (JDK) installed and you are using the Bash version 3.2
shell, perform the following steps:
 
-1. Edit your <code>/Users/_\<username\>/.bash\_profile</code> file and
add the following lines to the end of the file:
+1. Edit your <code>/Users/\<username\>/.bash\_profile</code> file and add
the following lines to the end of the file:
 
-    <pre><code>\#Set JAVA\_HOME
-    JAVA\_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0\_101.jdk/Contents/Home
-    export JAVA\_HOME;</code></pre>
+    <pre><code>#Set JAVA_HOME
+    JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home
+    export JAVA_HOME;</code></pre>
     
    Where <code>jdk1.8.0\_101.jdk</code> is the version of JDK that you have installed.
For example, if you have installed <code>jdk1.8.0\_102.jdk</code>, you would use
that value instead.
    
 2. Test to make sure you have set your JAVA\_HOME correctly:
     * Open a terminal window and type: <code>$JAVA\_HOME/bin/java -version</code>
     * Press return. If you see something like the following:
-      <pre><code>java version "1.5.0\_16"
-      Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0\_16-b06-284)
+      <pre><code>java version "1.5.0_16"
+      Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_16-b06-284)
       Java HotSpot (TM) Client VM (build 1.5.0\_16-133, mixed mode, sharing)</code></pre>
       
       Then you've successfully set your JAVA\_HOME environment variable to the binary stored
in <code>/Library/Java/JavaVirtualMachines/jdk1.8.0\_101.jdk/Contents/Home</code>.

\ No newline at end of file


Mime
View raw message