tree-walk: move doc to tree-walk.h
authorHeba Waly <heba.waly@gmail.com>
Sun, 17 Nov 2019 21:04:57 +0000 (21:04 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Nov 2019 06:21:29 +0000 (15:21 +0900)
commitbbcfa3002a6534613d8b74ecac0e19876dbfc2d3
tree9c746a68678afc00682517a38aa14b4d3feceecc
parentf1ecbe0f539ad8cb40cadb69e369cf42aa975d33
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-tree-walking.txt [deleted file]
tree-walk.h