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

docs/translations: add a notice at the end of each translated document #4650

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mudongliang
Copy link
Contributor

It is great to add a notice at the end of each translated document to remind readers that, this is a community-driven translation of the official syzkaller documentation.

@mudongliang
Copy link
Contributor Author

@a-nogikh please take a look at this PR.

@mudongliang
Copy link
Contributor Author

截屏2024-04-08 20 20 50

If I understand correctly, this should be the FP of ci/aux.

@a-nogikh
Copy link
Collaborator

a-nogikh commented Apr 8, 2024

Hmm, interesting, looks like we have some trouble with non-ascii characters here:

for F in $(find . -name "*.sh" -o -name "*.S" -o -name "*.py" -o -name "*.yml" -o -name "*.yaml" -o -name "*.md" | \
egrep -v "/vendor/|/gen/"); do
((FILES+=1))
L=0
while IFS= read -r LINE; do

@mudongliang
Copy link
Contributor Author

How do I handle this PR to bypass the CI checker?

@a-nogikh
Copy link
Collaborator

a-nogikh commented Apr 9, 2024

We need to fix the checker, but I haven't yet figured out how.

@mudongliang
Copy link
Contributor Author

A quick question: why does the previous translation of program_syntax.md bypass the CI? It should also have the empty line before the last notice? This is wired.

@a-nogikh
Copy link
Collaborator

Does it work if you do add a line break at the end of your .md files like we do in all other .md files?

It goes somewhat against the error message, but the checker script (./tools/check-whitespace.sh) does seem to have problems with files that don't end with a newline.

@mudongliang
Copy link
Contributor Author

Does it work if you do add a line break at the end of your .md files like we do in all other .md files?

It goes somewhat against the error message, but the checker script (./tools/check-whitespace.sh) does seem to have problems with files that don't end with a newline.

It seems not working.

It is great to add a notice at the end of each translated document
to remind readers that, this is a community-driven translation of
the official syzkaller documentation.

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
@a-nogikh
Copy link
Collaborator

I think it actually worked. Now it reports a different error:

Trailing whitespace at the end of the line. Please remove.

And I do indeed see whitespaces at the end of those two lines where it fired.

@mudongliang
Copy link
Contributor Author

Let me use a clean PR to complete this translation submission.

@mudongliang
Copy link
Contributor Author

I think it actually worked. Now it reports a different error:

Trailing whitespace at the end of the line. Please remove.

And I do indeed see whitespaces at the end of those two lines where it fired.

I remembered what's going on there.

I intentionally added two spaces at the end of that line and remove that empty line to make the ci happy. However, the ci reported the issue in the line with two spaces adding in the end.

You can take a look at the similar issue in which the commit is rebased on the master branch and trigger the ci again. The ci still reports the old problem.

@mudongliang mudongliang reopened this May 10, 2024
Copy link

codecov bot commented May 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.1%. Comparing base (e1feed8) to head (b20d571).

Additional details and impacted files

see 24 files with indirect coverage changes

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.

None yet

2 participants