From nobody Wed Oct 12 20:53:25 2022 X-Original-To: doc@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4MnlH9468pz4f2Bh for ; Wed, 12 Oct 2022 20:53:25 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4MnlH91sjJz3spv for ; Wed, 12 Oct 2022 20:53:25 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from kenobi.freebsd.org (kenobi.freebsd.org [IPv6:2610:1c1:1:606c::50:1d]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4MnlH90vXsz1R2M for ; Wed, 12 Oct 2022 20:53:25 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from kenobi.freebsd.org ([127.0.1.5]) by kenobi.freebsd.org (8.15.2/8.15.2) with ESMTP id 29CKrP39048553 for ; Wed, 12 Oct 2022 20:53:25 GMT (envelope-from bugzilla-noreply@freebsd.org) Received: (from www@localhost) by kenobi.freebsd.org (8.15.2/8.15.2/Submit) id 29CKrPen048552 for doc@FreeBSD.org; Wed, 12 Oct 2022 20:53:25 GMT (envelope-from bugzilla-noreply@freebsd.org) X-Authentication-Warning: kenobi.freebsd.org: www set sender to bugzilla-noreply@freebsd.org using -f From: bugzilla-noreply@freebsd.org To: doc@FreeBSD.org Subject: [Bug 267002] FreeBSD Handbook: incoherent sentences in kernel config section Date: Wed, 12 Oct 2022 20:53:25 +0000 X-Bugzilla-Reason: AssignedTo X-Bugzilla-Type: new X-Bugzilla-Watch-Reason: None X-Bugzilla-Product: Documentation X-Bugzilla-Component: Books & Articles X-Bugzilla-Version: Latest X-Bugzilla-Keywords: X-Bugzilla-Severity: Affects Many People X-Bugzilla-Who: henrix@camandro.org X-Bugzilla-Status: New X-Bugzilla-Resolution: X-Bugzilla-Priority: --- X-Bugzilla-Assigned-To: doc@FreeBSD.org X-Bugzilla-Flags: X-Bugzilla-Changed-Fields: bug_id short_desc product version rep_platform op_sys bug_status bug_severity priority component assigned_to reporter attachments.created Message-ID: Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Bugzilla-URL: https://bugs.freebsd.org/bugzilla/ Auto-Submitted: auto-generated List-Id: Documentation project List-Archive: https://lists.freebsd.org/archives/freebsd-doc List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-doc@freebsd.org MIME-Version: 1.0 ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1665608005; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=1Lu5tJusFCZQv06VboEXwgPjxDArRB7t+DZD7XeKsl4=; b=V7DtbSkV4iYz3gKh+bdoiOZhFcVL8ELKtNb2Xku0B6Ce7lK3k+U5EMCH7MN+6VsRltx9P6 q6ShW0EojO2ov55XW6FnSlrMDw6j/qq190QWw8sqxfDWzQcXkXQ/eOl98izMu1RqY6hMQ4 bBT54226TcIGQXIXoqJyZnPdHhboIQcRKpTcSg1bN9C1fdmkQeSBKoAK/AN7fXc2R7tEiZ P/tf+qHOIJRk7XqEU/nH+ADBKfSK4UD1n2zANNbBoLjTmnL5M4bUxPxLG1kxoYOMvrq6E+ spJAqBp7BIEtjvQORzZKhPylJgK8TNagL+05PRWgeJ1PZJzo59VuVxjrrx4D6A== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1665608005; a=rsa-sha256; cv=none; b=CmYoCszDPxulrsklSJW+HblFYIZOosVwL8FINrWP0iwVsDk8ceKSEB50e2nyKqfo8bebDj vHg3VBNEb89oCcP7dxtilvXYv5tX19aC7LCFB67Fbv7qsTVmzmybfXizERyQevg7tjaYcr yF7FDpKd5uLbcVsDRYc1a+AMKgTNjZbzZ5Fkqug0aDQgh2qCIGLTtLqMY50GxC8beHBHHS 7FN4oJW3rThC9KlJuw+f/QJ/QIbJgc9ZZZN44Nq9pNdpCbzLu9U/Xbpi1XUySFyjxBkH6N hFQatOTeHIrwJTI2GpjN3ydR1byTGKJpNhjY+PrYe+oXd/4dxmKYQVR35JN7/Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D267002 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=3D237245&action= =3Dedit first patch I'm attaching 2 patches to this bug report regarding some incoherent senten= ces (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 " 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 documentatio= n.=20 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 wi= th "The format of the kernel configuration file is simple" in [1]. That paragr= aph misses two '#' characters. Anyway, the details are all in that patch description, including how the pa= tch was (automatically) generated (except for a manual change). [1] https://docs.freebsd.org/en/books/handbook/kernelconfig/#kernelconfig-config --=20 You are receiving this mail because: You are the assignee for the bug.=