From nobody Thu Mar 07 05:40:52 2024 X-Original-To: freebsd-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 4Tqyp00Dbbz5Cm63 for ; Thu, 7 Mar 2024 05:40:56 +0000 (UTC) (envelope-from christopher.davidson@gmail.com) Received: from mail-yb1-xb2d.google.com (mail-yb1-xb2d.google.com [IPv6:2607:f8b0:4864:20::b2d]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "smtp.gmail.com", Issuer "GTS CA 1D4" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Tqynz0zfGz46Fp for ; Thu, 7 Mar 2024 05:40:55 +0000 (UTC) (envelope-from christopher.davidson@gmail.com) Authentication-Results: mx1.freebsd.org; dkim=pass header.d=gmail.com header.s=20230601 header.b=BxF2FOCI; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (mx1.freebsd.org: domain of christopher.davidson@gmail.com designates 2607:f8b0:4864:20::b2d as permitted sender) smtp.mailfrom=christopher.davidson@gmail.com Received: by mail-yb1-xb2d.google.com with SMTP id 3f1490d57ef6-dcc80d6004bso517796276.0 for ; Wed, 06 Mar 2024 21:40:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1709790054; x=1710394854; darn=freebsd.org; h=mime-version:content-language:accept-language:message-id:date :thread-index:thread-topic:subject:to:from:from:to:cc:subject:date :message-id:reply-to; bh=hXBh3jwrrzT9SS9g89hUEdY78u0Gk+i0VMHpoLRZcG0=; b=BxF2FOCIZO/jvkaAIx87BoPtFqfCDm/EPihG+ITQOw2eQwGX+0TF5JWjSSY6X9SkkA cT5D8vzQYQl1le5B4YmcZED6n8nKLe1171twwg5agfOaX+FzRsyuwt8zlo5YJzSWFqzQ HxUTU9YeixjQIGaSjT5n7oIE9S4uLAGPpkhwSpIowcwfP4VFaX8SThc0h5rHbinhF31i Q96exQpbmNFQ4G5BSrxuP7z2XC3Fzq12SXTmeeJs7bwBG0+MCs+SfKLCg3k1G6Zck/OO U1qOIm/l6846mZDdSaCMbfPLO5gqFZmuw56e4L9SEHshra5hJzp2jDHqjs/DlwqXSebe Rx5g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1709790054; x=1710394854; h=mime-version:content-language:accept-language:message-id:date :thread-index:thread-topic:subject:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=hXBh3jwrrzT9SS9g89hUEdY78u0Gk+i0VMHpoLRZcG0=; b=DCO8VHcEClCoBRco0LI0CGWLduW04JQby41dlpkQByWvnTyn1VErmAm1dBDUQxz1sP K3GwOeOTfMCzCJGaQIpl2Zv+adFRRpScNge146/ynKXcY4EPCofiUgscojI7Bhbg960r I+frvpAyYRRiXaE7oKtFM39QbWRjCUaPoG0Te8HZ4F5cQoWByv124enASKTxJ/5BfudD 0xiThmBjfuNmuTgVKHj9EIfEAKRQupgtvJwHxDYy+IlVgiipCGlQx53JM4UzDcj4/rid JDq80/tad7ymBlQzyhqCyeYQIfX9yZli1kRu0dRRohMXg8aoM7PWva/tE7FtOjAJcjNM 4s3A== X-Gm-Message-State: AOJu0YxeOS7M850KyVFaNgKVdWk/NVU0YVJU8tr9lY2VJ/MOFQ9IlpBc f2JEHG0IkMs/+iEFgrltvOsbvVWO7CAVKlFJHfZ6qCQdvET7pIvMJsUdcIz1 X-Google-Smtp-Source: AGHT+IFqdH0TqLebVht6S3Hvlq4ga/CL6TX8dwvEoURSILC0dBD1ebEKpxPnPxbo4pC9cqeFSVq2kA== X-Received: by 2002:a05:6902:1029:b0:dcf:47b6:9155 with SMTP id x9-20020a056902102900b00dcf47b69155mr17773591ybt.54.1709790053611; Wed, 06 Mar 2024 21:40:53 -0800 (PST) Received: from BN0PR20MB3750.namprd20.prod.outlook.com ([2603:1036:303:3818::5]) by smtp.gmail.com with ESMTPSA id j12-20020ac85f8c000000b0042ece270fdbsm3646063qta.93.2024.03.06.21.40.53 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 06 Mar 2024 21:40:53 -0800 (PST) From: Christopher Davidson To: "freebsd-doc@freebsd.org" Subject: Question relationship of builting(1) and functions refrenced through .Xr Thread-Topic: Question relationship of builting(1) and functions refrenced through .Xr Thread-Index: AQHacFHumGiyXoBgVkGDf1f8dmG2zg== X-MS-Exchange-MessageSentRepresentingType: 1 Date: Thu, 7 Mar 2024 05:40:52 +0000 Message-ID: Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-Exchange-Organization-SCL: -1 X-MS-TNEF-Correlator: X-MS-Exchange-Organization-RecordReviewCfmType: 0 Content-Type: multipart/alternative; boundary="_000_BN0PR20MB375038266F5C9168D2606A58A2202BN0PR20MB3750namp_" 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 X-Spamd-Bar: --- X-Spamd-Result: default: False [-4.00 / 15.00]; NEURAL_HAM_MEDIUM(-1.00)[-1.000]; NEURAL_HAM_LONG(-1.00)[-1.000]; NEURAL_HAM_SHORT(-1.00)[-1.000]; DMARC_POLICY_ALLOW(-0.50)[gmail.com,none]; R_SPF_ALLOW(-0.20)[+ip6:2607:f8b0:4000::/36]; R_DKIM_ALLOW(-0.20)[gmail.com:s=20230601]; MIME_GOOD(-0.10)[multipart/alternative,text/plain]; TO_MATCH_ENVRCPT_ALL(0.00)[]; RCVD_TLS_LAST(0.00)[]; ARC_NA(0.00)[]; FROM_HAS_DN(0.00)[]; MIME_TRACE(0.00)[0:+,1:+,2:~]; RCPT_COUNT_ONE(0.00)[1]; FREEMAIL_ENVFROM(0.00)[gmail.com]; FREEMAIL_FROM(0.00)[gmail.com]; TAGGED_FROM(0.00)[]; DKIM_TRACE(0.00)[gmail.com:+]; DWL_DNSWL_NONE(0.00)[gmail.com:dkim]; PREVIOUSLY_DELIVERED(0.00)[freebsd-doc@freebsd.org]; RCVD_COUNT_TWO(0.00)[2]; FROM_EQ_ENVFROM(0.00)[]; TO_DN_EQ_ADDR_ALL(0.00)[]; MLMMJ_DEST(0.00)[freebsd-doc@freebsd.org]; ASN(0.00)[asn:15169, ipnet:2607:f8b0::/32, country:US]; RCVD_VIA_SMTP_AUTH(0.00)[]; MISSING_XM_UA(0.00)[]; RCVD_IN_DNSWL_NONE(0.00)[2607:f8b0:4864:20::b2d:from] X-Rspamd-Queue-Id: 4Tqynz0zfGz46Fp --_000_BN0PR20MB375038266F5C9168D2606A58A2202BN0PR20MB3750namp_ Content-Type: text/plain; charset="Windows-1252" Content-Transfer-Encoding: quoted-printable Hi Documentation Team, I am investigating some updates to manual pages and came across a =93self r= eferencing=94 warning from the mandoc -Tlint utility, on entries associated= with the builtin(1) manual page. Some examples of this self referencing are: done(1), false(1), etc.. in pa= rticular entries on lines: 308, 309, 311,312,313,314,315,316,317,319,321,32= 2. These lines are associated with the SEE ALSO section which convention state= s we should use .Xr entries which causes the self-referencing warning. Question to the group is: How does the manual page relationship work betwee= n the builtin(1) manual pages and the individual .Xr links to other pages, = such as done(1) false(1)? I have a little more detail on this here: https://bughuntingfreebsd.wordpre= ss.com/2024/03/07/fixing-self-referencing/ I am currently at a lose to address this warning as using .Xr gives a warni= ng and using the .Nm is not the best option. Thank you in advance for any guidance or suggestions you can provide. Kind Regards, Chris --_000_BN0PR20MB375038266F5C9168D2606A58A2202BN0PR20MB3750namp_ Content-Type: text/html; charset="Windows-1252" Content-Transfer-Encoding: quoted-printable

Hi Documentation Team,=

 

I am investigating some updates to manual pag= es and came across a =93self referencing=94 warning from the mandoc -Tlint = utility, on entries associated with the builtin(1) manual page.<= /span>

 

 Some examples of this self referencing = are: done(1), false(1), etc.. in particular entries on lines: 308, 309, 311= ,312,313,314,315,316,317,319,321,322.

 

These lines are associated with the SEE ALSO = section which convention states we should use .Xr entries which causes the = self-referencing warning.

 

Question to the group is: How does the manual= page relationship work between the builtin(1) manual pages and the individ= ual .Xr links to other pages, such as done(1) false(1)?

 

I have a little more detail on this here: https://bughuntingfreebsd.wordpress.com/2024/03/0= 7/fixing-self-referencing/

 

I am currently at a lose to address this warn= ing as using .Xr gives a warning and using the .Nm is not the best option.<= o:p>

 

Thank you in advance for any guidance or sugg= estions you can provide.

 

Kind Regards,

Chris

 

 

--_000_BN0PR20MB375038266F5C9168D2606A58A2202BN0PR20MB3750namp_--