Page MenuHomeFreeBSD

Update security advisory template for Git
ClosedPublic

Authored by emaste on Apr 5 2021, 10:52 PM.

Details

Summary

(Will update the errata template with the same change, once we have a suitable change)

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

emaste created this revision.
emaste added a reviewer: imp.
emaste added subscribers: lwhsu, uqs, gjb.
emaste added inline comments.
website/static/security/advisory-template.txt
119–120

will replace sample hashes with XXXXXXXXXXXX

gjb added inline comments.
website/static/security/advisory-template.txt
127–146

Maybe just say 'for stable/13 and later', as releng/13.0 is branched from that. But I won't object if you decline this comment.

This revision is now accepted and ready to land.Apr 5 2021, 10:59 PM
website/static/security/advisory-template.txt
127–146

Or maybe just "FreeBSD 13 and later"?

website/static/security/advisory-template.txt
141

Duplicate "run"

I'd find the sentence easier to read if it were restructured, "run the following command to see which files were modified by a particular revision, replacing ..."

This revision now requires review to proceed.Apr 6 2021, 1:28 PM
markj added inline comments.
website/static/security/advisory-template.txt
129

A bit pedantic, but it looks like it should be "commit" instead of "hash".

This revision is now accepted and ready to land.Apr 6 2021, 1:44 PM

A bit pedantic, but it looks like it should be "commit" instead of "hash".

Perhaps "modified in a particular commit hash"? I think I wanted to use hash in prose to match the <hash> in the example command, but agree the previous version didn't read that well.

A bit pedantic, but it looks like it should be "commit" instead of "hash".

Perhaps "modified in a particular commit hash"? I think I wanted to use hash in prose to match the <hash> in the example command, but agree the previous version didn't read that well.

That seems ok. You could also change the example command to reference <commit hash>.

This revision now requires review to proceed.Apr 6 2021, 2:36 PM
gjb added inline comments.
website/static/security/advisory-template.txt
127–146

Works for me.

This revision is now accepted and ready to land.Apr 6 2021, 2:39 PM
This revision was automatically updated to reflect the committed changes.