From 8b588d51e87402c26da5588b0d394a6cbd478ed3 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sat, 15 Mar 2008 09:48:37 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.4.4-603-g1f9f --- config.txt | 4 +++ git-config.html | 11 +++++++- git-help.html | 62 ++++++++++++++++++++++++++++++++++++++-------- git-help.txt | 59 +++++++++++++++++++++++++++++++++++-------- git-submodule.html | 34 +++++++++++++++++++++---- git-submodule.txt | 19 +++++++++++--- 6 files changed, 159 insertions(+), 30 deletions(-) diff --git a/config.txt b/config.txt index ed2cb832b..0865f4e01 100644 --- a/config.txt +++ b/config.txt @@ -757,6 +757,10 @@ log.showroot:: Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which normally hide the root commit will now show it. True by default. +man.viewer:: + Specify the programs that may be used to display help in the + 'man' format. See linkgit:git-help[1]. + merge.summary:: Whether to include summaries of merged commits in newly created merge commit messages. False by default. diff --git a/git-config.html b/git-config.html index 4aae093fe..26628a873 100644 --- a/git-config.html +++ b/git-config.html @@ -1894,6 +1894,15 @@ log.showroot

+man.viewer +
+
+

+ Specify the programs that may be used to display help in the + man format. See git-help(1). +

+
+
merge.summary
@@ -2383,7 +2392,7 @@ web.browser diff --git a/git-help.html b/git-help.html index f90a143fa..f3d698fd2 100644 --- a/git-help.html +++ b/git-help.html @@ -304,8 +304,8 @@ former is internally converted into the latter.

- Use the info program to display the manual page, instead of - the man program that is used by default. + Display manual page for the command in the info format. The + info program will be used for that purpose.

@@ -313,18 +313,21 @@ former is internally converted into the latter.

- Use the man program to display the manual page. This may be - used to override a value set in the help.format - configuration variable. + Display manual page for the command in the man format. This + option may be used to override a value set in the + help.format configuration variable.

+

By default the man program will be used to display the manual page, +but the man.viewer configuration variable may be used to choose +other display programs (see below).

-w|--web

- Use a web browser to display the HTML manual page, instead of - the man program that is used by default. + Display manual page for the command in the web (HTML) + format. A web browser will be used for that purpose.

The web browser can be specified using the configuration variable help.browser, or web.browser if the former is not set. If none of @@ -336,6 +339,7 @@ these config variables is set, the git-web--browse helper script

CONFIGURATION VARIABLES

+

help.format

If no command line option is passed, the help.format configuration variable will be checked. The following values are supported for this variable; they make git-help behave as their corresponding command @@ -353,16 +357,52 @@ line option:

  • -"web" or "html" correspond to -w|--web, +"web" or "html" correspond to -w|--web.

    • +

    help.browser, web.browser and browser.<tool>.path

    The help.browser, web.browser and browser.<tool>.path will also be checked if the web format is chosen (either by command line option or configuration variable). See -w|--web in the OPTIONS section above and git-web--browse(1).

    -

    Note that these configuration variables should probably be set using -the --global flag, for example like this:

    +

    man.viewer

    +

    The man.viewer config variable will be checked if the man format +is chosen. Only the following values are currently supported:

    +
      +
    • +

      +"man": use the man program as usual, +

      +
      • +
    • +

      +"woman": use emacsclient to launch the "woman" mode in emacs +(this only works starting with emacsclient versions 22), +

      +
      • +
    • +

      +"konqueror": use a man KIO slave in konqueror. +

      +
      • +
    +

    Multiple values may be given to this configuration variable. Their +corresponding programs will be tried in the order listed in the +configuration file.

    +

    For example, this configuration:

    +
    +
    +
    [man]
+        viewer = konqueror
+        viewer = woman
    +
    +

    will try to use konqueror first. But this may fail (for example if +DISPLAY is not set) and in that case emacs' woman mode will be tried.

    +

    If everything fails the man program will be tried anyway.

    +

    Note about git config --global

    +

    Note that all these configuration variables should probably be set +using the --global flag, for example like this:

    $ git config --global help.format web
@@ -388,7 +428,7 @@ little. Maintenance is done by the git-list <git@vger.kernel.org>.
    diff --git a/git-help.txt b/git-help.txt index 0926dc12b..be2ae53b9 100644 --- a/git-help.txt +++ b/git-help.txt @@ -33,17 +33,21 @@ OPTIONS option supersedes any other option. -i|--info:: - Use the 'info' program to display the manual page, instead of - the 'man' program that is used by default. + Display manual page for the command in the 'info' format. The + 'info' program will be used for that purpose. -m|--man:: - Use the 'man' program to display the manual page. This may be - used to override a value set in the 'help.format' - configuration variable. + Display manual page for the command in the 'man' format. This + option may be used to override a value set in the + 'help.format' configuration variable. ++ +By default the 'man' program will be used to display the manual page, +but the 'man.viewer' configuration variable may be used to choose +other display programs (see below). -w|--web:: - Use a web browser to display the HTML manual page, instead of - the 'man' program that is used by default. + Display manual page for the command in the 'web' (HTML) + format. A web browser will be used for that purpose. + The web browser can be specified using the configuration variable 'help.browser', or 'web.browser' if the former is not set. If none of @@ -54,6 +58,9 @@ linkgit:git-web--browse[1] for more information about this. CONFIGURATION VARIABLES ----------------------- +help.format +~~~~~~~~~~~ + If no command line option is passed, the 'help.format' configuration variable will be checked. The following values are supported for this variable; they make 'git-help' behave as their corresponding command @@ -61,15 +68,47 @@ line option: * "man" corresponds to '-m|--man', * "info" corresponds to '-i|--info', -* "web" or "html" correspond to '-w|--web', +* "web" or "html" correspond to '-w|--web'. + +help.browser, web.browser and browser..path +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The 'help.browser', 'web.browser' and 'browser..path' will also be checked if the 'web' format is chosen (either by command line option or configuration variable). See '-w|--web' in the OPTIONS section above and linkgit:git-web--browse[1]. -Note that these configuration variables should probably be set using -the '--global' flag, for example like this: +man.viewer +~~~~~~~~~~ + +The 'man.viewer' config variable will be checked if the 'man' format +is chosen. Only the following values are currently supported: + +* "man": use the 'man' program as usual, +* "woman": use 'emacsclient' to launch the "woman" mode in emacs +(this only works starting with emacsclient versions 22), +* "konqueror": use a man KIO slave in konqueror. + +Multiple values may be given to this configuration variable. Their +corresponding programs will be tried in the order listed in the +configuration file. + +For example, this configuration: + + [man] + viewer = konqueror + viewer = woman + +will try to use konqueror first. But this may fail (for example if +DISPLAY is not set) and in that case emacs' woman mode will be tried. + +If everything fails the 'man' program will be tried anyway. + +Note about git config --global +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Note that all these configuration variables should probably be set +using the '--global' flag, for example like this: ------------------------------------------------ $ git config --global help.format web diff --git a/git-submodule.html b/git-submodule.html index b00e5ddfe..9adc56d3d 100644 --- a/git-submodule.html +++ b/git-submodule.html @@ -275,7 +275,8 @@ git-submodule(1) Manual Page
    git-submodule [--quiet] add [-b branch] [--] <repository> [<path>] git-submodule [--quiet] status [--cached] [--] [<path>…] -git-submodule [--quiet] [init|update] [--] [<path>…]
    +git-submodule [--quiet] [init|update] [--] [<path>…] +git-submodule [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>…]

    COMMANDS

    @@ -331,6 +332,17 @@ update This will make the submodules HEAD be detached.

    +
    +summary +
    +
    +

    + Show commit summary between the given commit (defaults to HEAD) and + working tree/index. For a submodule in question, a series of commits + in the submodule between the given super project commit and the + index or working tree (switched by --cached) are shown. +

    +

    OPTIONS

    @@ -357,9 +369,21 @@ update

    - Display the SHA-1 stored in the index, not the SHA-1 of the currently - checked out submodule commit. This option is only valid for the - status command. + This option is only valid for status and summary commands. These + commands typically use the commit found in the submodule HEAD, but + with this option, the commit stored in the index is used instead. +

    +
    +
    +-n, --summary-limit +
    +
    +

    + This option is only valid for the summary command. + Limit the summary size (number of commits shown in total). + Giving 0 will disable the summary; a negative number means unlimted + (the default). This limit only applies to modified submodules. The + size is always limited to 1 for added/deleted/typechanged submodules.

    @@ -391,7 +415,7 @@ for details.

    diff --git a/git-submodule.txt b/git-submodule.txt index b4d01605a..41f9f6356 100644 --- a/git-submodule.txt +++ b/git-submodule.txt @@ -12,6 +12,7 @@ SYNOPSIS 'git-submodule' [--quiet] add [-b branch] [--] [] 'git-submodule' [--quiet] status [--cached] [--] [...] 'git-submodule' [--quiet] [init|update] [--] [...] +'git-submodule' [--quiet] summary [--summary-limit ] [commit] [--] [...] COMMANDS @@ -47,6 +48,11 @@ update:: checkout the commit specified in the index of the containing repository. This will make the submodules HEAD be detached. +summary:: + Show commit summary between the given commit (defaults to HEAD) and + working tree/index. For a submodule in question, a series of commits + in the submodule between the given super project commit and the + index or working tree (switched by --cached) are shown. OPTIONS ------- @@ -57,9 +63,16 @@ OPTIONS Branch of repository to add as submodule. --cached:: - Display the SHA-1 stored in the index, not the SHA-1 of the currently - checked out submodule commit. This option is only valid for the - status command. + This option is only valid for status and summary commands. These + commands typically use the commit found in the submodule HEAD, but + with this option, the commit stored in the index is used instead. + +-n, --summary-limit:: + This option is only valid for the summary command. + Limit the summary size (number of commits shown in total). + Giving 0 will disable the summary; a negative number means unlimted + (the default). This limit only applies to modified submodules. The + size is always limited to 1 for added/deleted/typechanged submodules. :: Path to submodule(s). When specified this will restrict the command -- 2.26.2