[PATCH 2/2] docs: convert concept manpages to git-*

2013-02-01 Thread Jeff King
The manpages for commands have always been spelled
git-cmd. But concept manpages, like gitrevisions were
spelled without the dash. This is complex, and does not
actually buy anything. You might think it creates a separate
namespace for concepts and commands, but git help foo will
prefer the command form, meaning we must avoid such
conflicts anyway.

Let's just call everything git-*, which is simpler. This
patch renames the documentation files, updates the Makefile
to find them, and updates internal linkgit references to the
pages. It updates builtin/help.c so that users of git help
foo will not even notice the difference.

Users of external html links, or users who have trained
their fingers to type man gitfoo will notice the missing
pages. This patch does not install a this page has moved
placeholder, but that can easily be done on top.

Signed-off-by: Jeff King p...@peff.net
---
 Documentation/Makefile | 27 +
 Documentation/config.txt   |  8 ++---
 Documentation/diff-options.txt |  4 +--
 Documentation/git-cat-file.txt |  2 +-
 Documentation/git-check-ref-format.txt |  2 +-
 Documentation/git-cherry-pick.txt  |  2 +-
 Documentation/{gitcli.txt = git-cli.txt}  |  8 ++---
 Documentation/git-commit.txt   |  4 +--
 ...{gitcore-tutorial.txt = git-core-tutorial.txt} | 20 ++---
 Documentation/git-credential-cache.txt |  2 +-
 Documentation/git-credential-store.txt |  4 +--
 .../{gitcredentials.txt = git-credentials.txt}|  6 ++--
 ...{gitcvs-migration.txt = git-cvs-migration.txt} | 22 +++---
 Documentation/git-cvsimport.txt|  2 +-
 Documentation/git-cvsserver.txt|  2 +-
 Documentation/git-diff.txt |  6 ++--
 .../{gitdiffcore.txt = git-diffcore.txt}  |  6 ++--
 Documentation/git-fast-import.txt  |  2 +-
 Documentation/git-format-patch.txt |  2 +-
 Documentation/git-gc.txt   |  2 +-
 .../{gitglossary.txt = git-glossary.txt}  | 12 
 Documentation/{githooks.txt = git-hooks.txt}  |  6 ++--
 Documentation/git-http-backend.txt |  2 +-
 Documentation/git-log.txt  |  2 +-
 .../{gitnamespaces.txt = git-namespaces.txt}  |  6 ++--
 Documentation/git-push.txt |  2 +-
 Documentation/git-rebase.txt   |  4 +--
 Documentation/git-receive-pack.txt |  2 +-
 Documentation/git-reflog.txt   |  2 +-
 ...sitory-layout.txt = git-repository-layout.txt} | 10 +++
 Documentation/git-rev-parse.txt|  2 +-
 Documentation/git-revert.txt   |  2 +-
 .../{gitrevisions.txt = git-revisions.txt}|  6 ++--
 Documentation/git-show-branch.txt  |  2 +-
 Documentation/git-show-ref.txt |  2 +-
 Documentation/git-show.txt |  2 +-
 .../{gittutorial-2.txt = git-tutorial-2.txt}  | 24 +++
 .../{gittutorial.txt = git-tutorial.txt}  | 24 +++
 Documentation/git-update-server-info.txt   |  2 +-
 Documentation/git-upload-pack.txt  |  2 +-
 .../{gitworkflows.txt = git-workflows.txt}|  8 ++---
 Documentation/git.txt  | 35 +++---
 Documentation/gitignore.txt|  2 +-
 Documentation/gitk.txt |  2 +-
 Documentation/gitweb.conf.txt  |  2 +-
 Documentation/technical/api-credentials.txt|  2 +-
 Documentation/user-manual.txt  | 14 -
 builtin/help.c |  4 +--
 48 files changed, 159 insertions(+), 159 deletions(-)
 rename Documentation/{gitcli.txt = git-cli.txt} (98%)
 rename Documentation/{gitcore-tutorial.txt = git-core-tutorial.txt} (99%)
 rename Documentation/{gitcredentials.txt = git-credentials.txt} (98%)
 rename Documentation/{gitcvs-migration.txt = git-cvs-migration.txt} (94%)
 rename Documentation/{gitdiffcore.txt = git-diffcore.txt} (99%)
 rename Documentation/{gitglossary.txt = git-glossary.txt} (61%)
 rename Documentation/{githooks.txt = git-hooks.txt} (99%)
 rename Documentation/{gitnamespaces.txt = git-namespaces.txt} (97%)
 rename Documentation/{gitrepository-layout.txt = git-repository-layout.txt} 
(97%)
 rename Documentation/{gitrevisions.txt = git-revisions.txt} (88%)
 rename Documentation/{gittutorial-2.txt = git-tutorial-2.txt} (96%)
 rename Documentation/{gittutorial.txt = git-tutorial.txt} (97%)
 rename Documentation/{gitworkflows.txt = git-workflows.txt} (99%)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 8e7939f..552cc37 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -1,28 +1,29 @@ 

Re: [PATCH 2/2] docs: convert concept manpages to git-*

2013-02-01 Thread Jonathan Nieder
Jeff King wrote:

 Let's just call everything git-*, which is simpler. This
 patch renames the documentation files, updates the Makefile
 to find them, and updates internal linkgit references to the
 pages. It updates builtin/help.c so that users of git help
 foo will not even notice the difference.

 Users of external html links, or users who have trained
 their fingers to type man gitfoo will notice the missing
 pages. This patch does not install a this page has moved
 placeholder, but that can easily be done on top.

Thanks for writing this.

I think this one should wait until someone (perhaps me) takes care of
the redirects.  Ideally in addition to simple this place has moved
HTML placeholders and manpages using the .so macro, a makefile target
to generate redirect directives for your apache configuration might
make sense.

In the meantime, having man gitrepository-layout is not the worst
wart in the world.

Cheers,
Jonathan
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html