git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/1] [Outreachy] documentation: remove empty doc files
@ 2019-10-22 18:19 Heba Waly via GitGitGadget
  2019-10-22 18:19 ` [PATCH 1/1] " Heba Waly via GitGitGadget
  2019-10-23  7:25 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
  0 siblings, 2 replies; 13+ messages in thread
From: Heba Waly via GitGitGadget @ 2019-10-22 18:19 UTC (permalink / raw)
  To: git; +Cc: Heba Waly, Junio C Hamano

Remove empty and redundant documentation files from the
Documentation/technical/ directory.

As part of moving the documentation from Documentation/technical/api-* to
header files, the following files are deleted because they include only TODO
messages with no documentation: Documentation/technical/api-grep.txt
Documentation/technical/api-object-access.txt
Documentation/technical/api-quote.txt
Documentation/technical/api-xdiff-interface.txt

Signed-off-by: Heba Waly heba.waly@gmail.com [heba.waly@gmail.com]

Heba Waly (1):
  documentation: remove empty doc files

 Documentation/technical/api-grep.txt            |  8 --------
 Documentation/technical/api-object-access.txt   | 15 ---------------
 Documentation/technical/api-quote.txt           | 10 ----------
 Documentation/technical/api-xdiff-interface.txt |  7 -------
 4 files changed, 40 deletions(-)
 delete mode 100644 Documentation/technical/api-grep.txt
 delete mode 100644 Documentation/technical/api-object-access.txt
 delete mode 100644 Documentation/technical/api-quote.txt
 delete mode 100644 Documentation/technical/api-xdiff-interface.txt


base-commit: d966095db01190a2196e31195ea6fa0c722aa732
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-412%2FHebaWaly%2Fdelete_empty_docs-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-412/HebaWaly/delete_empty_docs-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/412
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH 1/1] documentation: remove empty doc files
  2019-10-22 18:19 [PATCH 0/1] [Outreachy] documentation: remove empty doc files Heba Waly via GitGitGadget
@ 2019-10-22 18:19 ` Heba Waly via GitGitGadget
  2019-10-22 21:04   ` Emily Shaffer
  2019-10-23  7:25 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
  1 sibling, 1 reply; 13+ messages in thread
From: Heba Waly via GitGitGadget @ 2019-10-22 18:19 UTC (permalink / raw)
  To: git; +Cc: Heba Waly, Junio C Hamano, Heba Waly

From: Heba Waly <heba.waly@gmail.com>

Remove empty and redundant documentation files from the
Documentation/technical/ directory.

As part of moving the documentation from Documentation/technical/api-* to
header files, the following files are deleted because they include only
TODO messages with no documentation to be moved:
Documentation/technical/api-grep.txt
Documentation/technical/api-object-access.txt
Documentation/technical/api-quote.txt
Documentation/technical/api-xdiff-interface.txt

Signed-off-by: Heba Waly <heba.waly@gmail.com>
---
 Documentation/technical/api-grep.txt            |  8 --------
 Documentation/technical/api-object-access.txt   | 15 ---------------
 Documentation/technical/api-quote.txt           | 10 ----------
 Documentation/technical/api-xdiff-interface.txt |  7 -------
 4 files changed, 40 deletions(-)
 delete mode 100644 Documentation/technical/api-grep.txt
 delete mode 100644 Documentation/technical/api-object-access.txt
 delete mode 100644 Documentation/technical/api-quote.txt
 delete mode 100644 Documentation/technical/api-xdiff-interface.txt

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)
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 1/1] documentation: remove empty doc files
  2019-10-22 18:19 ` [PATCH 1/1] " Heba Waly via GitGitGadget
@ 2019-10-22 21:04   ` Emily Shaffer
  2019-10-22 23:51     ` Junio C Hamano
  2019-10-23  7:22     ` Heba Waly
  0 siblings, 2 replies; 13+ messages in thread
From: Emily Shaffer @ 2019-10-22 21:04 UTC (permalink / raw)
  To: Heba Waly via GitGitGadget; +Cc: git, Heba Waly, Junio C Hamano

On Tue, Oct 22, 2019 at 06:19:35PM +0000, Heba Waly via GitGitGadget wrote:
> From: Heba Waly <heba.waly@gmail.com>
> 
> Remove empty and redundant documentation files from the
> Documentation/technical/ directory.
> 
> As part of moving the documentation from Documentation/technical/api-* to
> header files, the following files are deleted because they include only
> TODO messages with no documentation to be moved:
> Documentation/technical/api-grep.txt
> Documentation/technical/api-object-access.txt
> Documentation/technical/api-quote.txt
> Documentation/technical/api-xdiff-interface.txt

Same thing as I mentioned in your other review; what you've added to
your commit message now doesn't say anything you didn't say with the
diff. I can see that you removed empty documentation files; I can see
that those files include only TODO.

Maybe you can explain why it's a bad developer experience to stumble
across these, and that those files sat untouched for years in the
TODO(contributor-name) state.

> 
> Signed-off-by: Heba Waly <heba.waly@gmail.com>
> ---
>  Documentation/technical/api-grep.txt            |  8 --------
>  Documentation/technical/api-object-access.txt   | 15 ---------------
>  Documentation/technical/api-quote.txt           | 10 ----------
>  Documentation/technical/api-xdiff-interface.txt |  7 -------
>  4 files changed, 40 deletions(-)
>  delete mode 100644 Documentation/technical/api-grep.txt
>  delete mode 100644 Documentation/technical/api-object-access.txt
>  delete mode 100644 Documentation/technical/api-quote.txt
>  delete mode 100644 Documentation/technical/api-xdiff-interface.txt

As for the content of this change, I absolutely approve. I've stumbled
across some of these empty docs while looking for answers before and
found it really demoralizing - the community is so interested in
teaching me how to contribute that they've sat on a TODO for 12 years?
:( I even held up api-grep.txt as a (bad) example in a talk I gave this
year. I'm happy to see these files go.

 - Emily

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 1/1] documentation: remove empty doc files
  2019-10-22 21:04   ` Emily Shaffer
@ 2019-10-22 23:51     ` Junio C Hamano
  2019-10-23  7:23       ` Heba Waly
  2019-10-23  7:22     ` Heba Waly
  1 sibling, 1 reply; 13+ messages in thread
From: Junio C Hamano @ 2019-10-22 23:51 UTC (permalink / raw)
  To: Emily Shaffer; +Cc: Heba Waly via GitGitGadget, git, Heba Waly

Emily Shaffer <emilyshaffer@google.com> writes:

> As for the content of this change, I absolutely approve. I've stumbled
> across some of these empty docs while looking for answers before and
> found it really demoralizing - the community is so interested in
> teaching me how to contribute that they've sat on a TODO for 12 years?
> :( I even held up api-grep.txt as a (bad) example in a talk I gave this
> year. I'm happy to see these files go.

I'd approve this move, too, especially if we accompanied deletion
with addition (or verification of existence) of necessary docs
elsewhere (perhaps in *.h headers).


^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 1/1] documentation: remove empty doc files
  2019-10-22 21:04   ` Emily Shaffer
  2019-10-22 23:51     ` Junio C Hamano
@ 2019-10-23  7:22     ` Heba Waly
  1 sibling, 0 replies; 13+ messages in thread
From: Heba Waly @ 2019-10-23  7:22 UTC (permalink / raw)
  To: Emily Shaffer; +Cc: Heba Waly via GitGitGadget, git, Junio C Hamano

On Wed, Oct 23, 2019 at 10:05 AM Emily Shaffer <emilyshaffer@google.com> wrote:
>
> On Tue, Oct 22, 2019 at 06:19:35PM +0000, Heba Waly via GitGitGadget wrote:
> > From: Heba Waly <heba.waly@gmail.com>
> >
> > Remove empty and redundant documentation files from the
> > Documentation/technical/ directory.
> >
> > As part of moving the documentation from Documentation/technical/api-* to
> > header files, the following files are deleted because they include only
> > TODO messages with no documentation to be moved:
> > Documentation/technical/api-grep.txt
> > Documentation/technical/api-object-access.txt
> > Documentation/technical/api-quote.txt
> > Documentation/technical/api-xdiff-interface.txt
>
> Same thing as I mentioned in your other review; what you've added to
> your commit message now doesn't say anything you didn't say with the
> diff. I can see that you removed empty documentation files; I can see
> that those files include only TODO.
>
> Maybe you can explain why it's a bad developer experience to stumble
> across these, and that those files sat untouched for years in the
> TODO(contributor-name) state.
you're right!
> >
> > Signed-off-by: Heba Waly <heba.waly@gmail.com>
> > ---
> >  Documentation/technical/api-grep.txt            |  8 --------
> >  Documentation/technical/api-object-access.txt   | 15 ---------------
> >  Documentation/technical/api-quote.txt           | 10 ----------
> >  Documentation/technical/api-xdiff-interface.txt |  7 -------
> >  4 files changed, 40 deletions(-)
> >  delete mode 100644 Documentation/technical/api-grep.txt
> >  delete mode 100644 Documentation/technical/api-object-access.txt
> >  delete mode 100644 Documentation/technical/api-quote.txt
> >  delete mode 100644 Documentation/technical/api-xdiff-interface.txt
>
> As for the content of this change, I absolutely approve. I've stumbled
> across some of these empty docs while looking for answers before and
> found it really demoralizing - the community is so interested in
> teaching me how to contribute that they've sat on a TODO for 12 years?
> :( I even held up api-grep.txt as a (bad) example in a talk I gave this
> year. I'm happy to see these files go.
>
>  - Emily

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 1/1] documentation: remove empty doc files
  2019-10-22 23:51     ` Junio C Hamano
@ 2019-10-23  7:23       ` Heba Waly
  0 siblings, 0 replies; 13+ messages in thread
From: Heba Waly @ 2019-10-23  7:23 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: Emily Shaffer, Heba Waly via GitGitGadget, git

On Wed, Oct 23, 2019 at 12:52 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> Emily Shaffer <emilyshaffer@google.com> writes:
>
> > As for the content of this change, I absolutely approve. I've stumbled
> > across some of these empty docs while looking for answers before and
> > found it really demoralizing - the community is so interested in
> > teaching me how to contribute that they've sat on a TODO for 12 years?
> > :( I even held up api-grep.txt as a (bad) example in a talk I gave this
> > year. I'm happy to see these files go.
>
> I'd approve this move, too, especially if we accompanied deletion
> with addition (or verification of existence) of necessary docs
> elsewhere (perhaps in *.h headers).
Good point, although not all corresponding header files are
documented, but I'll include that in the commit message.

Thanks

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH v2 0/1] [Outreachy] documentation: remove empty doc files
  2019-10-22 18:19 [PATCH 0/1] [Outreachy] documentation: remove empty doc files Heba Waly via GitGitGadget
  2019-10-22 18:19 ` [PATCH 1/1] " Heba Waly via GitGitGadget
@ 2019-10-23  7:25 ` Heba Waly via GitGitGadget
  2019-10-23  7:25   ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
  2019-10-24 11:29   ` [PATCH v3 0/1] [Outreachy] " Heba Waly via GitGitGadget
  1 sibling, 2 replies; 13+ messages in thread
From: Heba Waly via GitGitGadget @ 2019-10-23  7:25 UTC (permalink / raw)
  To: git; +Cc: Heba Waly, Junio C Hamano

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: 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.

Signed-off-by: Heba Waly heba.waly@gmail.com [heba.waly@gmail.com]

Heba Waly (1):
  documentation: remove empty doc files

 Documentation/technical/api-grep.txt            |  8 --------
 Documentation/technical/api-object-access.txt   | 15 ---------------
 Documentation/technical/api-quote.txt           | 10 ----------
 Documentation/technical/api-xdiff-interface.txt |  7 -------
 4 files changed, 40 deletions(-)
 delete mode 100644 Documentation/technical/api-grep.txt
 delete mode 100644 Documentation/technical/api-object-access.txt
 delete mode 100644 Documentation/technical/api-quote.txt
 delete mode 100644 Documentation/technical/api-xdiff-interface.txt


base-commit: d966095db01190a2196e31195ea6fa0c722aa732
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-412%2FHebaWaly%2Fdelete_empty_docs-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-412/HebaWaly/delete_empty_docs-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/412

Range-diff vs v1:

 1:  ffdde613d8 ! 1:  5cd79e24fe documentation: remove empty doc files
     @@ -5,13 +5,22 @@
          Remove empty and redundant documentation files from the
          Documentation/technical/ directory.
      
     -    As part of moving the documentation from Documentation/technical/api-* to
     -    header files, the following files are deleted because they include only
     -    TODO messages with no documentation to be moved:
     -    Documentation/technical/api-grep.txt
     -    Documentation/technical/api-object-access.txt
     -    Documentation/technical/api-quote.txt
     -    Documentation/technical/api-xdiff-interface.txt
     +    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:
     +    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.
      
          Signed-off-by: Heba Waly <heba.waly@gmail.com>
      

-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH v2 1/1] documentation: remove empty doc files
  2019-10-23  7:25 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
@ 2019-10-23  7:25   ` Heba Waly via GitGitGadget
  2019-10-23 21:44     ` Emily Shaffer
  2019-10-24 11:29   ` [PATCH v3 0/1] [Outreachy] " Heba Waly via GitGitGadget
  1 sibling, 1 reply; 13+ messages in thread
From: Heba Waly via GitGitGadget @ 2019-10-23  7:25 UTC (permalink / raw)
  To: git; +Cc: Heba Waly, Junio C Hamano, Heba Waly

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:
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.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
---
 Documentation/technical/api-grep.txt            |  8 --------
 Documentation/technical/api-object-access.txt   | 15 ---------------
 Documentation/technical/api-quote.txt           | 10 ----------
 Documentation/technical/api-xdiff-interface.txt |  7 -------
 4 files changed, 40 deletions(-)
 delete mode 100644 Documentation/technical/api-grep.txt
 delete mode 100644 Documentation/technical/api-object-access.txt
 delete mode 100644 Documentation/technical/api-quote.txt
 delete mode 100644 Documentation/technical/api-xdiff-interface.txt

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)
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH v2 1/1] documentation: remove empty doc files
  2019-10-23  7:25   ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
@ 2019-10-23 21:44     ` Emily Shaffer
  2019-10-24 10:43       ` Heba Waly
  0 siblings, 1 reply; 13+ messages in thread
From: Emily Shaffer @ 2019-10-23 21:44 UTC (permalink / raw)
  To: Heba Waly via GitGitGadget; +Cc: git, Heba Waly, Junio C Hamano

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

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH v2 1/1] documentation: remove empty doc files
  2019-10-23 21:44     ` Emily Shaffer
@ 2019-10-24 10:43       ` Heba Waly
  0 siblings, 0 replies; 13+ messages in thread
From: Heba Waly @ 2019-10-24 10:43 UTC (permalink / raw)
  To: Emily Shaffer; +Cc: Heba Waly via GitGitGadget, git, Junio C Hamano

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

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH v3 0/1] [Outreachy] documentation: remove empty doc files
  2019-10-23  7:25 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
  2019-10-23  7:25   ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
@ 2019-10-24 11:29   ` Heba Waly via GitGitGadget
  2019-10-24 11:29     ` [PATCH v3 1/1] " Heba Waly via GitGitGadget
  1 sibling, 1 reply; 13+ messages in thread
From: Heba Waly via GitGitGadget @ 2019-10-24 11:29 UTC (permalink / raw)
  To: git; +Cc: Heba Waly, Junio C Hamano

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.

Some of the content which could have gone here already exists elsewhere:

 * api-object-access.txt -> sha1-file.c and object.h have some details.
 * api-quote.txt -> quote.h has some details.
 * api-xdiff-interface.txt -> xdiff-interface.h has some details.
 * api-grep.txt -> grep.h does not have enough documentation at the moment.

Signed-off-by: Heba Waly heba.waly@gmail.com [heba.waly@gmail.com]

Heba Waly (1):
  documentation: remove empty doc files

 Documentation/technical/api-grep.txt            |  8 --------
 Documentation/technical/api-object-access.txt   | 15 ---------------
 Documentation/technical/api-quote.txt           | 10 ----------
 Documentation/technical/api-xdiff-interface.txt |  7 -------
 4 files changed, 40 deletions(-)
 delete mode 100644 Documentation/technical/api-grep.txt
 delete mode 100644 Documentation/technical/api-object-access.txt
 delete mode 100644 Documentation/technical/api-quote.txt
 delete mode 100644 Documentation/technical/api-xdiff-interface.txt


base-commit: d966095db01190a2196e31195ea6fa0c722aa732
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-412%2FHebaWaly%2Fdelete_empty_docs-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-412/HebaWaly/delete_empty_docs-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/412

Range-diff vs v2:

 1:  5cd79e24fe ! 1:  ee64a075d3 documentation: remove empty doc files
     @@ -12,15 +12,11 @@
          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:
     -    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.
     +    Some of the content which could have gone here already exists elsewhere:
     +    - api-object-access.txt -> sha1-file.c and object.h have some details.
     +    - api-quote.txt -> quote.h has some details.
     +    - api-xdiff-interface.txt -> xdiff-interface.h has some details.
     +    - api-grep.txt -> grep.h does not have enough documentation at the moment.
      
          Signed-off-by: Heba Waly <heba.waly@gmail.com>
      

-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH v3 1/1] documentation: remove empty doc files
  2019-10-24 11:29   ` [PATCH v3 0/1] [Outreachy] " Heba Waly via GitGitGadget
@ 2019-10-24 11:29     ` Heba Waly via GitGitGadget
  2019-10-24 20:48       ` Emily Shaffer
  0 siblings, 1 reply; 13+ messages in thread
From: Heba Waly via GitGitGadget @ 2019-10-24 11:29 UTC (permalink / raw)
  To: git; +Cc: Heba Waly, Junio C Hamano, Heba Waly

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.

Some of the content which could have gone here already exists elsewhere:
- api-object-access.txt -> sha1-file.c and object.h have some details.
- api-quote.txt -> quote.h has some details.
- api-xdiff-interface.txt -> xdiff-interface.h has some details.
- api-grep.txt -> grep.h does not have enough documentation at the moment.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
---
 Documentation/technical/api-grep.txt            |  8 --------
 Documentation/technical/api-object-access.txt   | 15 ---------------
 Documentation/technical/api-quote.txt           | 10 ----------
 Documentation/technical/api-xdiff-interface.txt |  7 -------
 4 files changed, 40 deletions(-)
 delete mode 100644 Documentation/technical/api-grep.txt
 delete mode 100644 Documentation/technical/api-object-access.txt
 delete mode 100644 Documentation/technical/api-quote.txt
 delete mode 100644 Documentation/technical/api-xdiff-interface.txt

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)
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH v3 1/1] documentation: remove empty doc files
  2019-10-24 11:29     ` [PATCH v3 1/1] " Heba Waly via GitGitGadget
@ 2019-10-24 20:48       ` Emily Shaffer
  0 siblings, 0 replies; 13+ messages in thread
From: Emily Shaffer @ 2019-10-24 20:48 UTC (permalink / raw)
  To: Heba Waly via GitGitGadget; +Cc: git, Heba Waly, Junio C Hamano

On Thu, Oct 24, 2019 at 11:29:11AM +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.
> 
> Some of the content which could have gone here already exists elsewhere:
> - api-object-access.txt -> sha1-file.c and object.h have some details.
> - api-quote.txt -> quote.h has some details.
> - api-xdiff-interface.txt -> xdiff-interface.h has some details.
> - api-grep.txt -> grep.h does not have enough documentation at the moment.
> 
> Signed-off-by: Heba Waly <heba.waly@gmail.com>

Reviewed-by: Emily Shaffer <emilyshaffer@google.com>

Thanks, Heba.
 - Emily

^ permalink raw reply	[flat|nested] 13+ messages in thread

end of thread, other threads:[~2019-10-24 20:48 UTC | newest]

Thread overview: 13+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-10-22 18:19 [PATCH 0/1] [Outreachy] documentation: remove empty doc files Heba Waly via GitGitGadget
2019-10-22 18:19 ` [PATCH 1/1] " Heba Waly via GitGitGadget
2019-10-22 21:04   ` Emily Shaffer
2019-10-22 23:51     ` Junio C Hamano
2019-10-23  7:23       ` Heba Waly
2019-10-23  7:22     ` Heba Waly
2019-10-23  7:25 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
2019-10-23  7:25   ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
2019-10-23 21:44     ` Emily Shaffer
2019-10-24 10:43       ` Heba Waly
2019-10-24 11:29   ` [PATCH v3 0/1] [Outreachy] " Heba Waly via GitGitGadget
2019-10-24 11:29     ` [PATCH v3 1/1] " Heba Waly via GitGitGadget
2019-10-24 20:48       ` Emily Shaffer

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).