Re: [PATCH v3 01/21] diff: move doc to diff.h and diffcore.h
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Nov 12, 2019, 07:20 UTC
- Message-ID
- <xmqqmud1ef1p.fsf@gitster-ct.c.googlers.com>
- In-Reply-To
- <60e80b545f0f74e6fb58b5b6a64ecf3c1bd02d47.1573507684.git.gitgitgadget@gmail.com>
"Heba Waly via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 9 quoted lines
> From: Heba Waly <heba.waly@gmail.com> > > Move the documentation from Documentation/technical/api-diff.txt to both > diff.h and diffcore.h as it's easier for the developers to find the usage > information beside the code instead of looking for it in another doc file. > > Also documentation/technical/api-diff.txt is removed because the information > it has is now redundant and it'll be hard to keep it up to date and > synchronized with the documentation in the header files.
Show 5 quoted lines
> @@ -245,6 +370,7 @@ void diff_emit_submodule_error(struct diff_options *o, const char *err); > void diff_emit_submodule_pipethrough(struct diff_options *o, > const char *line, int len); > > +/* Output should be colored. */
I am not sure the comment belongs here. Especially if this was lifted from the description for COLOR_DIFF.
Those preprocessor constants have long been migrated to 1-bit bitfields in the diff_flags structure and the documentation was left stale---description on COLOR_DIFF and friends this patch removes from the doc should be reused to explain these fields, I would think.
Thanks.