From: Jonathan Nieder <jrnieder@gmail.com>
To: Jon Seymour <jon.seymour@gmail.com>
Cc: git@vger.kernel.org, gitster@pobox.com
Subject: [PATCH] Documentation: clarify meaning of --html-path, --man-path, and --info-path
Date: Mon, 2 May 2011 01:07:45 -0500 [thread overview]
Message-ID: <20110502060745.GC14547@elie> (raw)
In-Reply-To: <1304237785-56101-1-git-send-email-jon.seymour@gmail.com>
These options tell UI programs where git put its documentation, so
"Help" actions can show the documentation for *this* version of git
without regard to how MANPATH and INFOPATH are set up. Details:
. Each variable tells where documentation is expected to be. They do
not indicate whether documentation was actually installed.
. The output of "git --html-path" is an absolute path and can be used
in "file://$(git --html-path)/git-add.html" to name the HTML file
documenting a particular command.
. --man-path names a manual page hierarchy (e.g.,
/home/user/share/man). Its output can be passed to "man -M" or put
at the beginning of $MANPATH.
. --info-path names a directory with info files (e.g.,
/home/user/share/info). Its output is suitable as an argument to
"info -d" or for inclusion in $INFOPATH.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Sorry for the long tangent. Maybe a summary can be useful.
Documentation/git.txt | 12 ++++++------
1 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 7e9b521..5295315 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -287,16 +287,16 @@ help ...`.
the current setting and then exit.
--html-path::
- Print the path to wherever your git HTML documentation is installed
- and exit.
+ Print the path, without trailing slash, where git's HTML
+ documentation is installed and exit.
--man-path::
- Print the path to wherever your git man pages are installed
- and exit.
+ Print the manpath (see `man(1)`) for the man pages for
+ this version of git and exit.
--info-path::
- Print the path to wherever your git Info files are installed
- and exit.
+ Print the path where the Info files documenting this
+ version of git are installed and exit.
-p::
--paginate::
--
1.7.5
next prev parent reply other threads:[~2011-05-02 6:07 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-05-01 8:16 [PATCH] Add --info-path and --man-path options to git Jon Seymour
2011-05-01 18:15 ` Junio C Hamano
2011-05-01 22:47 ` Jon Seymour
2011-05-01 23:48 ` Jonathan Nieder
2011-05-01 23:53 ` Jonathan Nieder
2011-05-02 0:02 ` Junio C Hamano
2011-05-02 0:06 ` Jon Seymour
2011-05-02 0:12 ` Jon Seymour
2011-05-02 0:25 ` Jonathan Nieder
2011-05-02 3:47 ` Junio C Hamano
2011-05-02 5:15 ` Jonathan Nieder
2011-05-02 6:07 ` Jonathan Nieder [this message]
2011-05-02 6:49 ` [PATCH] Documentation: clarify meaning of --html-path, --man-path, and --info-path Jon Seymour
2011-05-02 17:24 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20110502060745.GC14547@elie \
--to=jrnieder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jon.seymour@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).