git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] gitremote-helpers.txt: rename from git-remote-helpers.txt

From
John Keeping <john@keeping.me.uk>
Date
Jan 31, 2013, 20:08 UTC
Message-ID
<fc96ae61bb64ce19e856d7a1624e2130c99afd47.1359662569.git.john@keeping.me.uk>
In-Reply-To
<7vfw1ijtz2.fsf@alter.siamese.dyndns.org>

When looking up a topic via "git help <topic>", git-help prepends "git-" to topics that are the names of commands (either builtin or found on the path) and "git" (no hyphen) to any other topic name.

"git-remote-helpers" is not the name of a command, so "git help remote-helpers" looks for "gitremote-helpers" and does not find it.

Fix this by renaming "git-remote-helpers.txt" to "gitremote-helpers.txt".

Signed-off-by: John Keeping <john@keeping.me.uk>
---
On Wed, Jan 30, 2013 at 12:28:49PM -0800, Junio C Hamano wrote:
Show 7 quoted lines
> John Keeping <john@keeping.me.uk> writes:
> >
> > Does this mean that "git-remote-helpers.txt" should lose the first
> > hyphen or is help.c not being clever enough in some way?
> 
> I think it is the former.  "git help tutorial" works exactly the
> same way.
This is the patch to rename it to "gitremote-helpers.txt".

Would we want to do something to avoid breaking links to the existing document as well?

 Documentation/git-remote-testgit.txt                            | 2 +-
 Documentation/{git-remote-helpers.txt => gitremote-helpers.txt} | 6 +++---
 Documentation/urls.txt                                          | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)
 rename Documentation/{git-remote-helpers.txt => gitremote-helpers.txt} (99%)
diff --git a/Documentation/git-remote-testgit.txt b/Documentation/git-remote-testgit.txt
index 612a625..f791d73 100644
--- a/Documentation/git-remote-testgit.txt
+++ b/Documentation/git-remote-testgit.txt
@@ -23,7 +23,7 @@ The best way to learn more is to read the comments and source code in
 
 SEE ALSO
 --------
-linkgit:git-remote-helpers[1]
+linkgit:gitremote-helpers[1]
 
 GIT
 ---
diff --git a/Documentation/git-remote-helpers.txt b/Documentation/gitremote-helpers.txt
similarity index 99%
rename from Documentation/git-remote-helpers.txt
rename to Documentation/gitremote-helpers.txt
index e36fdcb..0c91aba 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -1,9 +1,9 @@
-git-remote-helpers(1)
-=====================
+gitremote-helpers(1)
+====================
 
 NAME
 ----
-git-remote-helpers - Helper programs to interact with remote repositories
+gitremote-helpers - Helper programs to interact with remote repositories
 
 SYNOPSIS
 --------
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 539c0a0..3ca122f 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -55,7 +55,7 @@ may be used:
 
 where <address> may be a path, a server and path, or an arbitrary
 URL-like string recognized by the specific remote helper being
-invoked. See linkgit:git-remote-helpers[1] for details.
+invoked. See linkgit:gitremote-helpers[1] for details.
 
 If there are a large number of similarly-named remote repositories and
 you want to use a different format for them (such that the URLs you
-- 
1.8.1.1
Previous: Junio C HamanoNext: Matthieu Moy
Message 3 of 32 in “git-remote-helpers.txt: should it be gitremote-helpers.txt?”
  1. John KeepingJan 30, 2013
  2. Junio C HamanoJan 30, 2013
  3. gitremote-helpers.txt: rename from git-remote-helpers.txtJohn Keeping, Jan 31, 2013
  4. Matthieu MoyJan 31, 2013
  5. Junio C HamanoJan 31, 2013
  6. Rename {git- => git}remote-helpers.txtJohn Keeping, Jan 31, 2013
  7. Junio C HamanoJan 31, 2013
  8. John KeepingJan 31, 2013
  9. Junio C HamanoJan 31, 2013
  10. John KeepingJan 31, 2013
  11. Junio C HamanoJan 31, 2013
  12. Jeff KingJan 31, 2013
  13. Junio C HamanoJan 31, 2013
  14. Jonathan NiederJan 31, 2013
  15. Junio C HamanoJan 31, 2013
  16. Jonathan NiederJan 31, 2013
  17. Jeff KingFeb 1, 2013
  18. Junio C HamanoFeb 1, 2013
  19. Jeff KingFeb 1, 2013
  20. Jeff KingFeb 1, 2013
  21. 1/2 Documentation/Makefile: clean up MAN*_TXT listsJeff King, Feb 1, 2013
  22. Jonathan NiederFeb 1, 2013
  23. Junio C HamanoFeb 1, 2013
  24. Jeff KingFeb 1, 2013
  25. Jeff KingFeb 1, 2013
  26. 2/2 docs: convert "concept" manpages to git-*Jeff King, Feb 1, 2013
  27. Jonathan NiederFeb 1, 2013
  28. Junio C HamanoFeb 1, 2013
  29. Jeff KingFeb 1, 2013
  30. Junio C HamanoFeb 1, 2013
  31. Tomas CarneckyJan 31, 2013
  32. Junio C HamanoJan 31, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.