Re: [PATCH] Documentation: clarify meaning of --html-path, --man-path, and --info-path

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Acked.

On Mon, May 2, 2011 at 4:07 PM, Jonathan Nieder <jrnieder@xxxxxxxxx> wrote:
> 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@xxxxxxxxx>
> Signed-off-by: Jonathan Nieder <jrnieder@xxxxxxxxx>
> ---
> 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
>
>
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]