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.
listings
package to typset the diff, defining + and - as special line comment chars to typset them in e.g. different colors.CFONT
option, to generate a latex file that highlights the changes. You could then splice this into your document and add comments.