Bug 266692 - [PATCH] handbook/bsdinstall: Fix checksum files names in documentation
Summary: [PATCH] handbook/bsdinstall: Fix checksum files names in documentation
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: freebsd-doc (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-09-28 20:55 UTC by Luís Henriques
Modified: 2022-10-05 19:36 UTC (History)
1 user (show)

See Also:


Attachments
fix for this doc bug (2.96 KB, application/mbox)
2022-09-28 20:55 UTC, Luís Henriques
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Luís Henriques 2022-09-28 20:55:18 UTC
Created attachment 236927 [details]
fix for this doc bug

The handbook mentions a file named 'CHECKSUM.SHA256' to verify the downloaded FreeBSD image.  However, this name is misleading as it doesn't exist.  This commit fixes the file name and also mentions the extra SHA512 file.

While there, I'm also suggesting the usage of the sha{256,512}sum tools, shipped with FreeBSD base, that allow to automatically validate the checksums.
Comment 1 commit-hook freebsd_committer freebsd_triage 2022-10-05 14:25:31 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=b76576673c76dfc9c2b4a098bb6651b37e97fdf6

commit b76576673c76dfc9c2b4a098bb6651b37e97fdf6
Author:     Benedict Reuschling <bcr@FreeBSD.org>
AuthorDate: 2022-10-05 14:16:21 +0000
Commit:     Benedict Reuschling <bcr@FreeBSD.org>
CommitDate: 2022-10-05 14:16:21 +0000

    Fix checksum file names and verification instructions

    Explain how to find and verify the checksum algorithms provided with
    each release. Also mention the use of shasum tools and give a small
    usage example.

    I slighly modified the original submission to use FreeBSD 13.1 in the
    example. In other instances, simplify wording a bit to not repeat words
    too often within a sentence.

    PR:     266692
    Event:  Aberdeen Hackathon 2022

 .../content/en/books/handbook/bsdinstall/_index.adoc  | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)
Comment 2 Benedict Reuschling freebsd_committer freebsd_triage 2022-10-05 14:56:22 UTC
Thank you for submitting the patch. It was committed with minor modifications. PR closed.
Comment 3 Luís Henriques 2022-10-05 19:36:03 UTC
Wow! Awesome, my first FreeBSD patch has been committed!  Thanks.