TrustedComputingGroup / pandoc

Containers for building TCG specifications using Pandoc/LaTeX

BSD 3-Clause "New" or "Revised" License

2 stars 3 forks source link

Known shortcomings with diff-documents #166

Open chrisfenner opened 2 months ago

chrisfenner commented 2 months ago

Open

[ ] Strange numbering for deleted section headings

[ ] Completely deleted tables lose their tabular formatting

[ ] Changes only within tables sometimes don't mark the page as changed
[ ] Table cells with newlines sometimes have their newlines removed

Resolved

[x] Mermaid diagrams are always counted as changed because the temp filename changes

[x] Deleting a whole row from a table is a bit ugly (but adding one is fine)

[x] Edited equations don't get highlighted

[ ] Warning spew in latex when there are changes to equations

LaTeX Warning: Command \pdfstringdef invalid in math mode on input line 2323.

[ ] Code diffs indent a little weird

[x] Diffing algorithm inserts a few empty diffs in certain places

[x] Diff sometimes takes a LONG time. Consider splitting out diff generation job so that the main doc gets uploaded sooner?

Example: Part1 took 15 minutes in https://github.com/TrustedComputingGroup/TPM-Spec/actions/runs/10816111225

chrisfenner commented 2 months ago

Mermaid issue was resolved in #178