Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Outreachy] documentation: remove empty doc files #412

Closed
wants to merge 1 commit into from

Commits on Oct 24, 2019

  1. documentation: remove empty doc files

    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>
    HebaWaly committed Oct 24, 2019
    Configuration menu
    Copy the full SHA
    ee64a07 View commit details
    Browse the repository at this point in the history