| Message ID | 5cd79e24fe6bde7c5d10e1c2cae660858e3c4051.1571815556.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | documentation: remove empty doc files | expand |
On Wed, Oct 23, 2019 at 07:25:56AM +0000, Heba Waly via GitGitGadget wrote: > From: Heba Waly <heba.waly@gmail.com> > > Remove empty and redundant documentation files from the > Documentation/technical/ directory. > > The empty doc files included only TODO messages with no documentation for > years. Instead an approach is being taken to keep all doc beside the code > in the relevant header files. > Having empty doc files is confusing and disappointing to anybody looking > for information, besides having the documentation in header files makes it > easier for developers to find the information they are looking for. > > here's a list of the files removed and if the info can be found in the > corresponding header file: I think you can remove the above; in lots of composition contexts it tends to be bad form to say "Here is <something>: <something>" - don't warn us that you're going to present it, just present it. :) (Or, at least, this has been drilled into my head by many high school English teachers...) Maybe you could say something like, "Some of the content which could have gone here already exists elsewhere:" If you take that suggestion, you can probably move grep.h to the bottom, as it's the exception which doesn't have content that exists elsewhere. > 1- Documentation/technical/api-grep.txt -> grep.h does not have enough > documentation at the moment. > 2- Documentation/technical/api-object-access.txt -> sha1-file.c and > object.h have some details > 3- Documentation/technical/api-quote.txt -> quote.h has some details. > 4- Documentation/technical/api-xdiff-interface.txt -> xdiff-interface.h has > some details. For this list, I think you can remove the numbered bullet, and the leading "Documentation/technical/" - we can see the files deleted from the diff. - Emily
On Thu, Oct 24, 2019 at 10:44 AM Emily Shaffer <emilyshaffer@google.com> wrote: > > On Wed, Oct 23, 2019 at 07:25:56AM +0000, Heba Waly via GitGitGadget wrote: > > From: Heba Waly <heba.waly@gmail.com> > > > > Remove empty and redundant documentation files from the > > Documentation/technical/ directory. > > > > The empty doc files included only TODO messages with no documentation for > > years. Instead an approach is being taken to keep all doc beside the code > > in the relevant header files. > > Having empty doc files is confusing and disappointing to anybody looking > > for information, besides having the documentation in header files makes it > > easier for developers to find the information they are looking for. > > > > here's a list of the files removed and if the info can be found in the > > corresponding header file: > I think you can remove the above; in lots of composition contexts it > tends to be bad form to say "Here is <something>: <something>" - don't > warn us that you're going to present it, just present it. :) (Or, at > least, this has been drilled into my head by many high school English > teachers...) > > Maybe you could say something like, "Some of the content which could > have gone here already exists elsewhere:" If you take that suggestion, > you can probably move grep.h to the bottom, as it's the exception which > doesn't have content that exists elsewhere. That sounds better. Okay. > > 1- Documentation/technical/api-grep.txt -> grep.h does not have enough > > documentation at the moment. > > 2- Documentation/technical/api-object-access.txt -> sha1-file.c and > > object.h have some details > > 3- Documentation/technical/api-quote.txt -> quote.h has some details. > > 4- Documentation/technical/api-xdiff-interface.txt -> xdiff-interface.h has > > some details. > > For this list, I think you can remove the numbered bullet, and the > leading "Documentation/technical/" - we can see the files deleted from > the diff. yes. > - Emily Thanks
diff --git a/Documentation/technical/api-grep.txt b/Documentation/technical/api-grep.txt deleted file mode 100644 index a69cc8964d..0000000000 --- a/Documentation/technical/api-grep.txt +++ /dev/null @@ -1,8 +0,0 @@ -grep API -======== - -Talk about <grep.h>, things like: - -* grep_buffer() - -(JC) diff --git a/Documentation/technical/api-object-access.txt b/Documentation/technical/api-object-access.txt deleted file mode 100644 index 5b29622d00..0000000000 --- a/Documentation/technical/api-object-access.txt +++ /dev/null @@ -1,15 +0,0 @@ -object access API -================= - -Talk about <sha1-file.c> and <object.h> family, things like - -* read_sha1_file() -* read_object_with_reference() -* has_sha1_file() -* write_sha1_file() -* pretend_object_file() -* lookup_{object,commit,tag,blob,tree} -* parse_{object,commit,tag,blob,tree} -* Use of object flags - -(JC, Shawn, Daniel, Dscho, Linus) diff --git a/Documentation/technical/api-quote.txt b/Documentation/technical/api-quote.txt deleted file mode 100644 index e8a1bce94e..0000000000 --- a/Documentation/technical/api-quote.txt +++ /dev/null @@ -1,10 +0,0 @@ -quote API -========= - -Talk about <quote.h>, things like - -* sq_quote and unquote -* c_style quote and unquote -* quoting for foreign languages - -(JC) diff --git a/Documentation/technical/api-xdiff-interface.txt b/Documentation/technical/api-xdiff-interface.txt deleted file mode 100644 index 6296ecad1d..0000000000 --- a/Documentation/technical/api-xdiff-interface.txt +++ /dev/null @@ -1,7 +0,0 @@ -xdiff interface API -=================== - -Talk about our calling convention to xdiff library, including -xdiff_emit_consume_fn. - -(Dscho, JC)