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: fix HACKING.md broken links #14852

Merged
merged 2 commits into from
Feb 17, 2020
Merged

Conversation

LynnKirby
Copy link
Contributor

Noticed some broken/redirected links in the fuzzing section of docs/HACKING.md.

@evverx
Copy link
Member

evverx commented Feb 11, 2020

Thank you!

Given that we can't seem to keep the links up to date, I'm wondering if it would be better to replace the last three links with https://google.github.io/oss-fuzz/reference/useful-links/#tutorials?

@kkuehlz
Copy link
Contributor

kkuehlz commented Feb 12, 2020

Would also recommend making mkosi -i. That incremental flag will save you a lot of pain if you are doing lots of builds.

@LynnKirby
Copy link
Contributor Author

@evverx That's a good idea. I've pushed that change.

I also made them into actual links rather than just text. I noticed that the parser used to render the site (Kramdown) isn't set up with autolinks so they were appearing as plain text on the site. This differs from the appearance on GitHub because GFM always has autolinks on. I think Jekyll on GitHub pages has GFM support so maybe that can be turned on so that everything is consistent (just an idea, beyond the scope of this PR).

@keur I'm not sure what you mean. You think that info should be added to the document?

@evverx
Copy link
Member

evverx commented Feb 17, 2020

@LynnKirby thank you!

I noticed that the parser used to render the site (Kramdown) isn't set up with autolinks so they were appearing as plain text on the site. This differs from the appearance on GitHub because GFM always has autolinks on. I think Jekyll on GitHub pages has GFM support so maybe that can be turned on so that everything is consistent (just an idea, beyond the scope of this PR).

I'm not sure whether it's intentional or not. Could you open an issue so that it won't get lost?

Interestingly, judging by https://github.com/systemd/systemd/pull/14852/checks?check_run_id=451535293, since yeserday libFuzzer has been exiting with 72 on Azure Pipelines. That's probably where the documentation the links point to might come in handy :-)

Anyway, the PR looks good to me. I'll go ahead and merge it.

@evverx
Copy link
Member

evverx commented Feb 18, 2020

@keur regarding mkosi -i, I don't use mkosi so I can't comment on whether -i is helpful or not but if it does what I think it does (saving a lot of time along the way) I think it would probably make sense to mention it in the documentation. PRs are always welcome :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants