Skip to content

Implement [skip-revcheck] to exclude a commit from consideration - #21

Closed
fulldecent wants to merge 2 commits into
php:masterfrom
fulldecent:patch-1
Closed

Implement [skip-revcheck] to exclude a commit from consideration#21
fulldecent wants to merge 2 commits into
php:masterfrom
fulldecent:patch-1

Conversation

@fulldecent

Copy link
Copy Markdown

Discussion: php/doc-en#858 (comment)


This adds a new feature to the documentation translations checker:

Including the text:

[skip-revcheck]

in your commit message will exclude a commit from consideration in the tools at http://doc.php.net/revcheck.php

You should use this when:

  • Making typo corrections to the EN documentation that do not require the attention of the translations teams.
  • Making formatting corrections to the EN documentation that do not require the attention of the translations teams.

I am not sure where to add that additional documentation meta notes. But I hope we can please document it as part of this PR.

@Girgias

Girgias commented Aug 23, 2021

Copy link
Copy Markdown
Member

@nilgun could you have a look at this, I don't really know how this version of the revcheck script works.

Comment thread scripts/rev.php
@salathe

salathe commented Aug 23, 2021

Copy link
Copy Markdown
Contributor

What is the plan for getting every single author to be aware of this, and ensuring that it happens for every single commit that should be skipped (because even missing the tag from one commit for a file kind of defeats its usefulness)?

@fulldecent

Copy link
Copy Markdown
Author

I am requesting help to find where to document this new feature.


This new feature is proposed specifically because I am making large commits that are touching many (300+) files and these changes on the English version do not require review by translators.

Using this just for one commit makes it possible to continue using recheck after my proposed commit goes through.

All other commits that use it will be an incremental benefit. And I think that translators who are downstream from any commits which should, but don't, use this skip-revcheck will be happy to remind upstream committers to use it next time.

@nilgun

nilgun commented Sep 1, 2021 via email

Copy link
Copy Markdown
Member

@nilgun

nilgun commented Sep 1, 2021

Copy link
Copy Markdown
Member

The extreme case of the absence of the hash​ (Turkish file status):
(Except for all other problems)

File status type Number of files Percent of files Size of files (kB) Percent of size
Up to date files 0 0.00%   0.00%
Outdated files 3412 32.74% 10515 40.10%
Work in progress 0 0.00% 0 0.00%
Files without revision number 0 0.00% 0 0.00%
Not in EN tree 0 0.00% 0 0.00%
Files available for translation 7011 67.26% 15706 59.90%

Generated: 01 Sep 2021 19:22:48

@nilgun nilgun closed this in daf0c80 Sep 1, 2021
@Girgias

Girgias commented Sep 2, 2021

Copy link
Copy Markdown
Member

Thanks for implementing this!

@fulldecent

Copy link
Copy Markdown
Author

Thank you for the review! I'm working to get a big commit in to take advantage of this...

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

Successfully merging this pull request may close these issues.

4 participants