Commit 208246dc authored by iannucci@chromium.org's avatar iannucci@chromium.org

Move docs folder to man.

This makes the depot_tools manpages automatically show up in the effective
MANPATH for mac/linux.

R=agable@chromium.org
BUG=

Review URL: https://codereview.chromium.org/259863004

git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@266667 0039d316-1c4b-4281-b951-d872f2087c98
parent c9cf90ae
...@@ -809,7 +809,7 @@ commands mentioned in this tutorial.</p></div> ...@@ -809,7 +809,7 @@ commands mentioned in this tutorial.</p></div>
</td> </td>
<td class="content">If your platform does not support manpages (or you prefer something a bit more <td class="content">If your platform does not support manpages (or you prefer something a bit more
expressive than plain text) you can find all documentation in <em>html</em> form in the expressive than plain text) you can find all documentation in <em>html</em> form in the
<code>[DEPOT_TOOLS]/docs/html</code> folder.</td> <code>[DEPOT_TOOLS]/man/html</code> folder.</td>
</tr></table> </tr></table>
</div> </div>
<div class="sect2"> <div class="sect2">
...@@ -875,21 +875,13 @@ Litmus Test ...@@ -875,21 +875,13 @@ Litmus Test
<div class="content"> <div class="content">
<pre><code><strong><span class="white">$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools</span></strong></code></pre> <pre><code><strong><span class="white">$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools</span></strong></code></pre>
</div></div> </div></div>
<div class="paragraph"><p>Add <em>depot_tools</em> to the <em>end</em> of your PATH and MANPATH (you will probably want <div class="paragraph"><p>Add <em>depot_tools</em> to the <em>end</em> of your PATH (you will probably want to put this
to put this in your <code>~/.bashrc</code> or <code>~/.zshrc</code>). Assuming you cloned in your <code>~/.bashrc</code> or <code>~/.zshrc</code>). Assuming you cloned <em>depot_tools</em> to
<em>depot_tools</em> to <code>/path/to/depot_tools</code>:</p></div> <code>/path/to/depot_tools</code>:</p></div>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><code><strong><span class="white">$ export PATH=$PATH:/path/to/depot_tools</span></strong> <pre><code><strong><span class="white">$ export PATH=$PATH:/path/to/depot_tools</span></strong></code></pre>
<strong><span class="white">$ export MANPATH=$MANPATH:/path/to/depot_tools/docs</span></strong> <b>&lt;1&gt;</b></code></pre>
</div></div> </div></div>
<div class="colist arabic"><ol>
<li>
<p>
Observe that this path is <code>depot_tools/</code><strong><code>docs</code></strong>.
</p>
</li>
</ol></div>
</div> </div>
<div class="sect3"> <div class="sect3">
<h4 id="_windows">WINDOWS</h4> <h4 id="_windows">WINDOWS</h4>
...@@ -1587,7 +1579,7 @@ from <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git"> ...@@ -1587,7 +1579,7 @@ from <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git">
<div id="footnotes"><hr /></div> <div id="footnotes"><hr /></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2014-04-14 16:26:14 PDT Last updated 2014-04-28 13:55:43 PDT
</div> </div>
</div> </div>
</body> </body>
......
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
.\" Title: depot_tools_tutorial .\" Title: depot_tools_tutorial
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 04/14/2014 .\" Date: 04/28/2014
.\" Manual: Chromium depot_tools Manual .\" Manual: Chromium depot_tools Manual
.\" Source: depot_tools e722300 .\" Source: depot_tools 32af7d9
.\" Language: English .\" Language: English
.\" .\"
.TH "DEPOT_TOOLS_TUTORIAL" "7" "04/14/2014" "depot_tools e722300" "Chromium depot_tools Manual" .TH "DEPOT_TOOLS_TUTORIAL" "7" "04/28/2014" "depot_tools 32af7d9" "Chromium depot_tools Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
...@@ -135,7 +135,7 @@ Please refer to the manpages (or \-\-help output) for details about any of the c ...@@ -135,7 +135,7 @@ Please refer to the manpages (or \-\-help output) for details about any of the c
.ps -1 .ps -1
.br .br
.sp .sp
If your platform does not support manpages (or you prefer something a bit more expressive than plain text) you can find all documentation in \fIhtml\fR form in the [DEPOT_TOOLS]/docs/html folder\&. If your platform does not support manpages (or you prefer something a bit more expressive than plain text) you can find all documentation in \fIhtml\fR form in the [DEPOT_TOOLS]/man/html folder\&.
.sp .5v .sp .5v
.RE .RE
.SS "PREREQUISITES" .SS "PREREQUISITES"
...@@ -222,23 +222,18 @@ Clone the \fIdepot_tools\fR repository: ...@@ -222,23 +222,18 @@ Clone the \fIdepot_tools\fR repository:
.\} .\}
.sp .sp
.sp .sp
Add \fIdepot_tools\fR to the \fIend\fR of your PATH and MANPATH (you will probably want to put this in your ~/\&.bashrc or ~/\&.zshrc)\&. Assuming you cloned \fIdepot_tools\fR to /path/to/depot_tools: Add \fIdepot_tools\fR to the \fIend\fR of your PATH (you will probably want to put this in your ~/\&.bashrc or ~/\&.zshrc)\&. Assuming you cloned \fIdepot_tools\fR to /path/to/depot_tools:
.sp .sp
.if n \{\ .if n \{\
.RS 4 .RS 4
.\} .\}
.nf .nf
\fB$ export PATH=$PATH:/path/to/depot_tools\fR \fB$ export PATH=$PATH:/path/to/depot_tools\fR
\fB$ export MANPATH=$MANPATH:/path/to/depot_tools/docs\fR \fB(1)\fR
.fi .fi
.if n \{\ .if n \{\
.RE .RE
.\} .\}
.sp .sp
.sp
\fB1. \fRObserve that this path is
depot_tools/\fBdocs\fR\&.
.br
.SS "BOOTSTRAPPING CONFIGURATION" .SS "BOOTSTRAPPING CONFIGURATION"
.sp .sp
If you have never used git before, you\(cqll need to set some global git configurations; substitute your name and email address in the following commands: If you have never used git before, you\(cqll need to set some global git configurations; substitute your name and email address in the following commands:
......
...@@ -29,7 +29,7 @@ commands mentioned in this tutorial. ...@@ -29,7 +29,7 @@ commands mentioned in this tutorial.
[NOTE] [NOTE]
If your platform does not support manpages (or you prefer something a bit more If your platform does not support manpages (or you prefer something a bit more
expressive than plain text) you can find all documentation in 'html' form in the expressive than plain text) you can find all documentation in 'html' form in the
`[DEPOT_TOOLS]/docs/html` folder. `[DEPOT_TOOLS]/man/html` folder.
PREREQUISITES PREREQUISITES
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
...@@ -74,16 +74,14 @@ Clone the 'depot_tools' repository: ...@@ -74,16 +74,14 @@ Clone the 'depot_tools' repository:
[white]**$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools** [white]**$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools**
---- ----
Add 'depot_tools' to the 'end' of your PATH and MANPATH (you will probably want Add 'depot_tools' to the 'end' of your PATH (you will probably want to put this
to put this in your `~/.bashrc` or `~/.zshrc`). Assuming you cloned in your `~/.bashrc` or `~/.zshrc`). Assuming you cloned 'depot_tools' to
'depot_tools' to `/path/to/depot_tools`: `/path/to/depot_tools`:
[postsubs="quotes"] [postsubs="quotes"]
---- ----
[white]**$ export PATH=$PATH:/path/to/depot_tools** [white]**$ export PATH=$PATH:/path/to/depot_tools**
[white]**$ export MANPATH=$MANPATH:/path/to/depot_tools/docs** <1>
---- ----
<1> Observe that this path is +depot_tools/+**+docs+**.
// No need to show the Windows stuff on the manpage output. // No need to show the Windows stuff on the manpage output.
ifdef::backend-xhtml11[] ifdef::backend-xhtml11[]
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment