Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revcheck changes #175

Closed
alfsb opened this issue Nov 10, 2024 · 2 comments
Closed

Revcheck changes #175

alfsb opened this issue Nov 10, 2024 · 2 comments

Comments

@alfsb
Copy link
Member

alfsb commented Nov 10, 2024

With the imminent implantation of #174 , I would like to make some changes. This issue discusses some minor issues that I think could be discussed in block.

IGNORE_EXTENSIONS_XML

The actual revcheck ignores files named extensions.xml that are autogenerated. But the way the ignore are constructed, the code also ignores some non-autogenerated, translatable files.

  • appendices/migration56/extensions.xml -- existent, translatable, not tracked;
  • install/windows/legacy/extensions.xml -- deleted on en/, may exist untracked on translations.

This is documented as IGNORE_EXTENSIONS_XML on PR above, and changing/removing this in the code will cause the files mentioned above to be tracked.

STATUS_COUNT_MISMATCH

The actual revcheck counts "outdated" files in two different ways;

RevTagProblem is counted towards as Old in one case, but files are shown in a separated listing (because it is impossible to generate diffs with invalid hashes). As aside, NotInEnTree is not counted at all in first case, and files in this situation are counted in the second case (default).

This causes a mismatch between translators totals and file summary, and other mismatch between Old counts and file listings.

To resolve this, I propose to change the "wip" column in Translator's summary to "misc", and so any status other than "ok" and "old"
to be counted here.

  • ok : files that are ready and hashes matches: count and listing for ok cases matches;
  • old: files that are ready and hashes mismatch: count and listing for old cases matches;
  • misc: any other case.

IGNORE_ONLY_WS_CHANGE (not commited)

On discussion about better diffs, I observed that is possible to analyse files changes to determine it has changed only in terms of ws, automatically with git diff -b, or by processing text files. This can alleviate the translation's efforts in two ways:

  1. To ignore "uninteresting" whitespaces changes, even if [skip-revcheck] was not utilized;
  2. To ignore "uninteresting" whitespaces changes buried in squashed commits, even if [skip-revcheck] was utilized.

The second point above needs more context. The actual behaviour of revcheck is to ignore all files in a squashed commit if one of the commits is marked [skip-revcheck]. This obviously causes problems (as documented here), and I'm planning to change this in the following weeks.

But instead of marking all files changed in squashed commits, an extra step for TranslatedOld files is to check if its changes are only uninteresting whitespace changes, so it is marked ok, even if the hashes does not match.

Discussion

All the changes above will change revcheck output, and will mark files synced or outdated differently, as result.

So... comments? In favor or against these changes? Push it in block or case by case?

@alfsb
Copy link
Member Author

alfsb commented Nov 10, 2024

Also, CHM manuals are building again? Because there is chmonly/ dir that not is tracked in revcheck, but seems to have translatable files. If these files are included in all translated CHMs, i would like include these files in revcheck tracking.

@alfsb
Copy link
Member Author

alfsb commented Nov 11, 2024

Issue being tracked in PR 176.

@alfsb alfsb closed this as completed Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant