[PATCH] fix "builtin-*" references to be "builtin/*"

[PATCH] fix "builtin-*" references to be "builtin/*"

[Phil Hord]

Documentation and some comments still refer to files in builtin/
as 'builtin-*.[cho]'.  Update these to show the correct location.

Signed-off-by: Phil Hord <hordp@cisco.com>
---
 Documentation/git-log.txt                     |  4 ++--
 Documentation/technical/api-builtin.txt       |  2 +-
 Documentation/technical/api-parse-options.txt | 12 ++++++------
 Documentation/user-manual.txt                 | 10 +++++-----
 builtin/help.c                                |  2 +-
 builtin/notes.c                               |  2 +-
 builtin/replace.c                             |  2 +-
 transport.c                                   |  2 +-
 transport.h                                   |  2 +-
 9 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 4687fe8..2ea79ba 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -128,9 +128,9 @@ Examples
 	in the "release" branch, along with the list of paths
 	each commit modifies.
 
-`git log --follow builtin-rev-list.c`::
+`git log --follow builtin/rev-list.c`::
 
-	Shows the commits that changed builtin-rev-list.c, including
+	Shows the commits that changed builtin/rev-list.c, including
 	those commits that occurred before the file was given its
 	present name.
 
diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt
index 4a4228b..f3c1357 100644
--- a/Documentation/technical/api-builtin.txt
+++ b/Documentation/technical/api-builtin.txt
@@ -39,7 +39,7 @@ where options is the bitwise-or of:
 	on bare repositories.
 	This only makes sense when `RUN_SETUP` is also set.
 
-. Add `builtin-foo.o` to `BUILTIN_OBJS` in `Makefile`.
+. Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
 
 Additionally, if `foo` is a new command, there are 3 more things to do:
 
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 1317db4..0be2b51 100644
--- a/Documentation/technical/api-parse-options.txt
+++ b/Documentation/technical/api-parse-options.txt
@@ -275,10 +275,10 @@ Examples
 --------
 
 See `test-parse-options.c` and
-`builtin-add.c`,
-`builtin-clone.c`,
-`builtin-commit.c`,
-`builtin-fetch.c`,
-`builtin-fsck.c`,
-`builtin-rm.c`
+`builtin/add.c`,
+`builtin/clone.c`,
+`builtin/commit.c`,
+`builtin/fetch.c`,
+`builtin/fsck.c`,
+`builtin/rm.c`
 for real-world examples.
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index e831cc2..2483700 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -4256,7 +4256,7 @@ no longer need to call `setup_pager()` directly).
 Nowadays, `git log` is a builtin, which means that it is _contained_ in the
 command `git`.  The source side of a builtin is
 
-- a function called `cmd_<bla>`, typically defined in `builtin-<bla>.c`,
+- a function called `cmd_<bla>`, typically defined in `builtin/<bla>.c`,
   and declared in `builtin.h`,
 
 - an entry in the `commands[]` array in `git.c`, and
@@ -4264,7 +4264,7 @@ command `git`.  The source side of a builtin is
 - an entry in `BUILTIN_OBJECTS` in the `Makefile`.
 
 Sometimes, more than one builtin is contained in one source file.  For
-example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin-log.c`,
+example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin/log.c`,
 since they share quite a bit of code.  In that case, the commands which are
 _not_ named like the `.c` file in which they live have to be listed in
 `BUILT_INS` in the `Makefile`.
@@ -4287,10 +4287,10 @@ For the sake of clarity, let's stay with `git cat-file`, because it
 - is plumbing, and
 
 - was around even in the initial commit (it literally went only through
-  some 20 revisions as `cat-file.c`, was renamed to `builtin-cat-file.c`
+  some 20 revisions as `cat-file.c`, was renamed to `builtin/cat-file.c`
   when made a builtin, and then saw less than 10 versions).
 
-So, look into `builtin-cat-file.c`, search for `cmd_cat_file()` and look what
+So, look into `builtin/cat-file.c`, search for `cmd_cat_file()` and look what
 it does.
 
 ------------------------------------------------------------------
@@ -4366,7 +4366,7 @@ Another example: Find out what to do in order to make some script a
 builtin:
 
 -------------------------------------------------
-$ git log --no-merges --diff-filter=A builtin-*.c
+$ git log --no-merges --diff-filter=A builtin/*.c
 -------------------------------------------------
 
 You see, Git is actually the best tool to find out about the source of Git
diff --git a/builtin/help.c b/builtin/help.c
index 062957f..ce7b889 100644
--- a/builtin/help.c
+++ b/builtin/help.c
@@ -1,5 +1,5 @@
 /*
- * builtin-help.c
+ * builtin/help.c
  *
  * Builtin help command
  */
diff --git a/builtin/notes.c b/builtin/notes.c
index 57748a6..d9a67d9 100644
--- a/builtin/notes.c
+++ b/builtin/notes.c
@@ -4,7 +4,7 @@
  * Copyright (c) 2010 Johan Herland <johan@herland.net>
  *
  * Based on git-notes.sh by Johannes Schindelin,
- * and builtin-tag.c by Kristian Høgsberg and Carlos Rica.
+ * and builtin/tag.c by Kristian Høgsberg and Carlos Rica.
  */
 
 #include "cache.h"
diff --git a/builtin/replace.c b/builtin/replace.c
index 398ccd5..59d3115 100644
--- a/builtin/replace.c
+++ b/builtin/replace.c
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2008 Christian Couder <chriscool@tuxfamily.org>
  *
- * Based on builtin-tag.c by Kristian Høgsberg <krh@redhat.com>
+ * Based on builtin/tag.c by Kristian Høgsberg <krh@redhat.com>
  * and Carlos Rica <jasampler@gmail.com> that was itself based on
  * git-tag.sh and mktag.c by Linus Torvalds.
  */
diff --git a/transport.c b/transport.c
index 359a671..e15db98 100644
--- a/transport.c
+++ b/transport.c
@@ -1232,7 +1232,7 @@ int transport_fetch_refs(struct transport *transport, struct ref *refs)
 		 * then local and remote refs are likely to still be equal.
 		 * Just feed them all to the fetch method in that case.
 		 * This condition shouldn't be met in a non-deepening fetch
-		 * (see builtin-fetch.c:quickfetch()).
+		 * (see builtin/fetch.c:quickfetch()).
 		 */
 		heads = xmalloc(nr_refs * sizeof(*heads));
 		for (rm = refs; rm; rm = rm->next)
diff --git a/transport.h b/transport.h
index 4edebc5..ea70ea7 100644
--- a/transport.h
+++ b/transport.h
@@ -170,7 +170,7 @@ int transport_connect(struct transport *transport, const char *name,
 int transport_helper_init(struct transport *transport, const char *name);
 int bidirectional_transfer_loop(int input, int output);
 
-/* common methods used by transport.c and builtin-send-pack.c */
+/* common methods used by transport.c and builtin/send-pack.c */
 void transport_verify_remote_names(int nr_heads, const char **heads);
 
 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
-- 
1.8.3.1.560.gb7ca476.dirty

Re: [PATCH] fix "builtin-*" references to be "builtin/*"

[Jonathan Nieder]

Hi,

Phil Hord wrote:

> Documentation and some comments still refer to files in builtin/
> as 'builtin-*.[cho]'.  Update these to show the correct location.

Yeah, good call.

[...]
> --- a/builtin/help.c
> +++ b/builtin/help.c
> @@ -1,5 +1,5 @@
>  /*
> - * builtin-help.c
> + * builtin/help.c
>   *

It would probably be better to remove the above two lines which are
redundant next to the filename.  That can wait for a later patch if
you like, though.

With or without that change,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Re: [PATCH] fix "builtin-*" references to be "builtin/*"

[Junio C Hamano]

Phil Hord <hordp@cisco.com> writes:

> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index e831cc2..2483700 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -4256,7 +4256,7 @@ no longer need to call `setup_pager()` directly).
>  Nowadays, `git log` is a builtin, which means that it is _contained_ in the
>  command `git`.  The source side of a builtin is
>  
> -- a function called `cmd_<bla>`, typically defined in `builtin-<bla>.c`,
> +- a function called `cmd_<bla>`, typically defined in `builtin/<bla>.c`,
>    and declared in `builtin.h`,

If we were to do this, we would need to update the "1.5.3 or newer"
comment at the top of this file to "1.7.1 or newer" ;-).

More seriously, it may be OK to say

	typically defined in `builtin/<bla.c>` (note that older
	versions of Git used to have it in `builtin-<bla>.c`
	instead), and declared in `builtin.h`.

only here, and then apply your s|builtin-|builtin/| changes to the
remainder of this file.

> diff --git a/builtin/help.c b/builtin/help.c
> index 062957f..ce7b889 100644
> --- a/builtin/help.c
> +++ b/builtin/help.c
> @@ -1,5 +1,5 @@
>  /*
> - * builtin-help.c
> + * builtin/help.c
>   *
>   * Builtin help command
>   */

As Jonathan said, dropping this line (and the line after it) would
be a sane thing to do.

Other than that, the patch looked good.