]> git.ipfire.org Git - thirdparty/git.git/commit
trace2: move doc to trace2.h
authorHeba Waly <heba.waly@gmail.com>
Sun, 17 Nov 2019 21:04:59 +0000 (21:04 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Nov 2019 06:21:29 +0000 (15:21 +0900)
commit6c51cb525da47a751b856bba55522ca9d4c24dac
treedc324f6f561d1280781cb5610bb290b12ecd10ba
parentd95a77d05988ed1682c3e2bf1b94523341ef58b7
trace2: move doc to trace2.h

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-trace2.txt
trace2.h