Skip to content

README.md

Latest commit

 

History

History
59 lines (47 loc) · 2.43 KB

README.md

File metadata and controls

59 lines (47 loc) · 2.43 KB
Raw

Sample reports

These synthetic example patches show how diffofdiffs presents changes made against different versions of a source file. Each HTML report contains the complete output, including its delta and context sections. Download a report and open it locally to try the viewing controls.

Example What to look for Report
Argument changes Upstream's calls use record->state.seq instead of record->seq; both patches add the same generation increment arguments.html
Indentation One source nests the added lines; the other uses an early return. A separate addition uses eight spaces on one side and a tab on the other indentation.html

The inputs are in arguments/ and indentation/. The reports use patch mode, so source outside the quoted regions remains unknown. For complete source, compare commits with --git-tree as described in the user guide.

Regeneration

Run these commands from the repository root to rebuild diffofdiffs and regenerate the HTML reports, or check whether they need updating:

make update-samples
make check-samples

make check and make check-asan also compare the tracked HTML against fresh output. These checks leave the reports untouched; regenerate and review them when the version, renderer, embedded assets, or example patches change. Each report's footer identifies the diffofdiffs version that generated it. Matching the generated output establishes freshness, so review the result for correctness before committing it.

The regeneration helper runs the equivalent of these commands:

(
    cd samples/arguments
    ../../diffofdiffs --backport-labels --html --theme=light \
        -o ../arguments.html backport.patch upstream.patch
)
(
    cd samples/indentation
    ../../diffofdiffs --backport-labels --html --theme=dark \
        -o ../indentation.html backport.patch upstream.patch
)

To view the same comparison in a terminal, omit --html, --theme, and -o. Add --color=always when saving ANSI output.

The PNG screenshots show each report through the end of its delta section, with Text size set to Large, a 1440-pixel browser viewport, and a device scale factor of 1.5. Their themes match the commands above; the remaining controls use their defaults. Update the screenshots separately when a change affects their appearance.