From: Emily Shaffer <emilyshaffer@google.com>
To: Heba Waly via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Heba Waly <heba.waly@gmail.com>,
Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v3 1/1] documentation: remove empty doc files
Date: Thu, 24 Oct 2019 13:48:40 -0700 [thread overview]
Message-ID: <20191024204840.GH9323@google.com> (raw)
In-Reply-To: <ee64a075d3074718a47da4ed369cee6923d0b460.1571916551.git.gitgitgadget@gmail.com>
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
prev parent reply other threads:[~2019-10-24 20:48 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
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 message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191024204840.GH9323@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=heba.waly@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).