Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 15 Aug 2023 02:05:36 GMT
From:      Graham Perrin <grahamperrin@FreeBSD.org>
To:        doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org
Subject:   git: c68a09252d - main - FreeBSD Handbook: fix a long note
Message-ID:  <202308150205.37F25aRa076346@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch main has been updated by grahamperrin:

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

commit c68a09252dd1468aad41dabe184d6bea8c62a3d9
Author:     Graham Perrin <grahamperrin@FreeBSD.org>
AuthorDate: 2023-08-15 02:01:20 +0000
Commit:     Graham Perrin <grahamperrin@FreeBSD.org>
CommitDate: 2023-08-15 02:01:20 +0000

    FreeBSD Handbook: fix a long note
    
    The unusually long note at
    https://github.com/freebsd/freebsd-doc/commit/a7640c82441bdf19f738af7d3b144b011750e0be?diff=unified#diff-ea68d032fa51f56f82ff87b0de858972275dc98728c98e5a8b28b6ef9640cc1cR1208-R1299
    (lines 1208–1299) included a title and paragraph; a table; some
    paragraphs, one of which referenced the table; then a callout list,
    with number 2 referencing the same table.
    
    The nested table at
    https://docs-archive.freebsd.org/doc/11.1-RELEASE/usr/local/share/doc/freebsd/en_US.ISO8859-1/books/handbook/makeworld.html#updating-src-obtaining-src-checkout
    scales well enough when the browser window is narrowed.
    
    Nesting in the current edition of the chapter, captured at
    https://web.archive.org/web/20230810000557/https://docs.freebsd.org/en/books/handbook/cutting-edge/#synching
    does not scale so well.
    
    PDF is similarly bugged; page 597 under
    https://web.archive.org/web/20230813183522if_/https://download.freebsd.org/doc/en/books/handbook/handbook_en.pdf#%5B%7B%22num%22%3A4112%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C0%2C260.15%2Cnull%5D
    
    The original note was probably intended to end after the first
    paragraph – before the table. Do this now, before other changes to the
    chapter.
    
    Fixes: a7640c82441b Rewrite the Build from Source section, simplifying and clarifying.
---
 documentation/content/en/books/handbook/cutting-edge/_index.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/content/en/books/handbook/cutting-edge/_index.adoc b/documentation/content/en/books/handbook/cutting-edge/_index.adoc
index 6b11ddc80d..8f33b9a18e 100644
--- a/documentation/content/en/books/handbook/cutting-edge/_index.adoc
+++ b/documentation/content/en/books/handbook/cutting-edge/_index.adoc
@@ -783,10 +783,11 @@ After it finishes, the source code is up to date and the build process described
 
 [NOTE]
 ====
-*Obtaining the Source:* +
+Obtaining the source:
 
 If the output says `fatal: not a git repository`, the files there are missing or were installed with a different method.
 A new checkout of the source is required.
+====
 
 [[updating-src-obtaining-src-repopath]]
 .FreeBSD Versions and Repository Branches
@@ -833,7 +834,6 @@ That path is used when checking out the source:
 <.> Move the old directory out of the way. If there are no local modifications in this directory, it can be deleted.
 
 <.> The path from <<updating-src-obtaining-src-repopath>> is added to the repository URL. The third parameter is the destination directory for the source code on the local system.
-====
 
 [[updating-src-building]]
 === Building from Source



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202308150205.37F25aRa076346>