GeneralDocumenting on code revisions

General information and discussion about TeXnicCenter
Post Reply
Ganesh Ujwal
Posts: 1
Joined: Wed Dec 10, 2014 12:39 pm

Documenting on code revisions

Post by Ganesh Ujwal »

I have made modifications to a few files of a C++ program. I would like to document on these changes in a nice LaTeX report, by showing exactly what I modified and explaining why I did so.

Since there are quite a lot of lines of code that have changed, it is not really an option to go through all of them manually, copy and paste relevant bits and add commentary.

My questions are:

How would you go about making such a document, preferably with colors or some markup to clearly show differences?
Would you show the code versions side by side, or rather show a kind of diff log?
Where would you add commentary?
I am thinking of using the terminal git diff color output as a basis, somehow getting LaTeX to typeset this and adding in my comments.

Recommended reading 2024:

LaTeXguide.org • LaTeX-Cookbook.net • TikZ.org

NEW: TikZ book now 40% off at Amazon.com for a short time.

Post Reply