git: bb4bdb25db - main - content/en: Use <<section>> for linking within a document

Sergio Carlavilla carlavilla at freebsd.org
Tue Apr 20 11:01:40 UTC 2021


On Tue, 20 Apr 2021 at 12:58, Mateusz Piotrowski <0mp at freebsd.org> wrote:

> The branch main has been updated by 0mp:
>
> URL:
> https://cgit.FreeBSD.org/doc/commit/?id=bb4bdb25db841acd73da3ce543c964afe49f7f63
>
> commit bb4bdb25db841acd73da3ce543c964afe49f7f63
> Author:     Mateusz Piotrowski <0mp at FreeBSD.org>
> AuthorDate: 2021-04-20 10:49:32 +0000
> Commit:     Mateusz Piotrowski <0mp at FreeBSD.org>
> CommitDate: 2021-04-20 10:49:32 +0000
>
>     content/en: Use <<section>> for linking within a document
>
>     I've used the following script to locate all the cases where crossref
>     was used to link to a section within the same document:
>
>       grep -R crossref: | while read -r case; do
>           file=${case%%:*}
>           dir=${file%/*}
>           dir_name=${dir##*/}
>           line=${case##*:}
>           target_document=${line%%[*}
>           if [ "$dir_name" = "$target_document" ]; then
>               echo "$case"
>           fi
>       done
> ---
>  documentation/content/en/books/handbook/mirrors/_index.adoc | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/documentation/content/en/books/handbook/mirrors/_index.adoc
> b/documentation/content/en/books/handbook/mirrors/_index.adoc
> index 6d1aaafa1d..940df19568 100644
> --- a/documentation/content/en/books/handbook/mirrors/_index.adoc
> +++ b/documentation/content/en/books/handbook/mirrors/_index.adoc
> @@ -524,7 +524,7 @@ To update [.filename]#/usr/src# created in the example
> above, use:
>
>  The update is much quicker than a checkout, only transferring files that
> have changed.
>
> -There are also external mirrors maintained by project members available,
> please refer to the crossref:mirrors[external-mirrors,External mirrors]
> section.
> +There are also external mirrors maintained by project members available,
> please refer to the <<external-mirrors>> section.
>
>  === SSH related information
>
> @@ -554,7 +554,7 @@ These are also published as SSHFP records in DNS.
>  === Web-based repository browser
>
>  The FreeBSD project currently uses cgit as the web-based repository
> browser: https://cgit.freebsd.org/.
> -The <https://cgit.freebsd.org/.-The> URLs of indivirual repositories are
> listed crossref:mirrors[git-url-table,here].
> +The URLs of indivirual repositories are listed in <<git-url-table>>.
>
>  === For Users
>
> @@ -730,7 +730,7 @@ This section demonstrates how to install Subversion on
> a FreeBSD system and use
>
>  FreeBSD systems older than 12._x_ do not have proper root certificates.
>  Those certificates allow Subversion to verify the identity of HTTPS
> repository server.
> -Installation instructions are described in
> crossref:mirrors[git-ssl-certificates,“Root SSL Certificates”].
> +Installation instructions are described in <<git-ssl-certificates>>.
>
>  [[svn-svnlite]]
>  === Svnlite
>
Hi,

Nice script! Thanks!


More information about the dev-commits-doc-all mailing list