-
Notifications
You must be signed in to change notification settings - Fork 127
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] Move doc to header files #434
Commits on Nov 15, 2019
-
diff: move doc to diff.h and diffcore.h
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. There are three members documented in the doc file that weren't found in the header files, assuming the doc wasn't up to date and the members no longer exist: touched_flags, COLOR_DIFF_WORDS and QUIET. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 7f2f4c4 - Browse repository at this point
Copy the full SHA 7f2f4c4View commit details -
Move the documentation from Documentation/technical/api-directory-listing.txt to dir.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-directory-listing.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. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for f87ca02 - Browse repository at this point
Copy the full SHA f87ca02View commit details -
graph: move doc to graph.h and graph.c
Move the documentation from Documentation/technical/api-history-graph.txt to graph.h and graph.c as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file. The graph library was already well documented, so few comments were added to both graph.h and graph.c Also documentation/technical/api-history-graph.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 495fe33 - Browse repository at this point
Copy the full SHA 495fe33View commit details -
Move the related documentation from Documentation/technical/api-merge.txt to ll-merge.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. Only the ll-merge related doc is removed from documentation/technical/api-merge.txt because this information will be redundant and it'll be hard to keep it up to date and synchronized with the documentation in ll-merge.h. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 90baf40 - Browse repository at this point
Copy the full SHA 90baf40View commit details -
sha1-array: move doc to sha1-array.h
Move the documentation from Documentation/technical/api-oid-array.txt to sha1-array.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-oid-array.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for a76a2e2 - Browse repository at this point
Copy the full SHA a76a2e2View commit details -
remote: move doc to remote.h and refspec.h
Move the documentation from Documentation/technical/api-remote.txt to remote.h and refspec.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. N.B. The doc for both push and fetch members of the remote struct aren't moved because they are out of date, as the members were changed from arrays of rspecs to struct refspec 2 years ago. Also documentation/technical/api-remote.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 5719b81 - Browse repository at this point
Copy the full SHA 5719b81View commit details -
Move the documentation from Documentation/technical/api-ref-iteration.txt to refs.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-ref-iteration.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for f84c133 - Browse repository at this point
Copy the full SHA f84c133View commit details -
Move the documentation from Documentation/technical/api-gitattributes.txt to attr.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-gitattributes.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for a007b50 - Browse repository at this point
Copy the full SHA a007b50View commit details -
revision: move doc to revision.h
Move the documentation from Documentation/technical/api-revision-walking.txt to revision.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-revision-walking.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 8855303 - Browse repository at this point
Copy the full SHA 8855303View commit details -
pathspec: move doc to pathspec.h
Move the documentation from Documentation/technical/api-setup.txt to pathspec.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-setup.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 0042d10 - Browse repository at this point
Copy the full SHA 0042d10View commit details -
sigchain: move doc to sigchain.h
Move the documentation from Documentation/technical/api-sigchain.txt to sigchain.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-sigchain.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 240a4bc - Browse repository at this point
Copy the full SHA 240a4bcView commit details -
Move the documentation from Documentation/technical/api-allocation-growing.txt to cache.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-allocation-growing.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 3e0d3f2 - Browse repository at this point
Copy the full SHA 3e0d3f2View commit details -
argv-array: move doc to argv-array.h
Move the documentation from Documentation/technical/api-argv-array.txt to argv-array.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-argv-array.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 4f805c8 - Browse repository at this point
Copy the full SHA 4f805c8View commit details -
credential: move doc to credential.h
Move the documentation from Documentation/technical/api-credentials.txt to credential.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. Documentation/technical/api-credentials.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 file. Documentation/git-credential.txt and Documentation/gitcredentials.txt now link to credential.h instead of Documentation/technical/api-credentials.txt for details about the credetials API. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for ea78cb4 - Browse repository at this point
Copy the full SHA ea78cb4View commit details
Commits on Nov 17, 2019
-
parse-options: add link to doc file in parse-options.h
Add a link to Documentation/technical/api-parse-options.txt in parse-options.h So the developers would know where to find more info about the API. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 0e9e89f - Browse repository at this point
Copy the full SHA 0e9e89fView commit details -
run-command: move doc to run-command.h
Move the documentation from Documentation/technical/api-run-command.txt to run-command.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. Documentation/technical/api-run-command.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 474911f - Browse repository at this point
Copy the full SHA 474911fView commit details -
Move the documentation from Documentation/technical/api-trace.txt to trace.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. Documentation/technical/api-trace.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for f313d74 - Browse repository at this point
Copy the full SHA f313d74View commit details -
tree-walk: move doc to tree-walk.h
Move the documentation from Documentation/technical/api-tree-walking.txt to tree-walk.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. Documentation/technical/api-tree-walking.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 file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 9063c2f - Browse repository at this point
Copy the full SHA 9063c2fView commit details -
submodule-config: move doc to submodule-config.h
Move the documentation from Documentation/technical/api-submodule-config.txt to submodule-config.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. Documentation/technical/api-submodule-config.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 file. The documentation of parse_submodule_config_option() is discarded as the function was removed 2 years ago. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 039598b - Browse repository at this point
Copy the full SHA 039598bView commit details -
Move the functions documentation from Documentation/technical/api-trace2.txt to trace2.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. Only the functions documentation section is removed from Documentation/technical/api-trace2.txt as the file is full of details that seemed more appropriate to be in a separate doc file as it is, with a link to the doc file added in the trace2.h. Also the functions doc is removed to avoid having redundandt info which will be hard to keep syncronized with the documentation in the header file. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for cf3e3dd - Browse repository at this point
Copy the full SHA cf3e3ddView commit details -
api-index: remove api doc index files
Remove both api-index.txt and api-index-skel.txt as the API documentation is being moved to the header files, so the index is not needed anymore because the doc files (Documentation/technical/api-*.txt) will be gone. Make changes to Documentation/Makefile accordingly. Signed-off-by: Heba Waly <heba.waly@gmail.com>
Configuration menu - View commit details
-
Copy full SHA for 3771f7e - Browse repository at this point
Copy the full SHA 3771f7eView commit details