[Bug 267002] FreeBSD Handbook: incoherent sentences in kernel config section

From: <bugzilla-noreply_at_freebsd.org>
Date: Wed, 12 Oct 2022 20:53:25 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=267002

            Bug ID: 267002
           Summary: FreeBSD Handbook: incoherent sentences in kernel
                    config section
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Many People
          Priority: ---
         Component: Books & Articles
          Assignee: doc@FreeBSD.org
          Reporter: henrix@camandro.org

Created attachment 237245
  --> https://bugs.freebsd.org/bugzilla/attachment.cgi?id=237245&action=edit
first patch

I'm attaching 2 patches to this bug report regarding some incoherent sentences
(and one mistake) in the kernel configuration section.
The first patch has the following changes:

1. "ath wireless Ethernet driver" is incorrect; use "ath wireless network
driver" instead.
2. "Source can be installed using Git and the instructions in <ref>" doesn't
sound correct; rephased a bit.
3. The troubleshooting note starts with a very long and confusing sentence;
rephrased.

The second patch is more an RFC: I don't think it's correct, or, at least, it
isn't complete.  Basically, there are asciidoc mistakes in the documentation. 
And I found some while reading the above mentioned section in the handbook.  As
the patch description suggests, have a look at the paragraph that starts with
"The format of the kernel configuration file is simple" in [1]. That paragraph
misses two '#' characters.

Anyway, the details are all in that patch description, including how the patch
was (automatically) generated (except for a manual change).

[1]
https://docs.freebsd.org/en/books/handbook/kernelconfig/#kernelconfig-config

-- 
You are receiving this mail because:
You are the assignee for the bug.