From nobody Fri Mar 08 21:24:54 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 4Ts0112HPsz5DsGG for ; Fri, 8 Mar 2024 21:39:01 +0000 (UTC) (envelope-from christopher.davidson@gmail.com) Received: from mail-yw1-x112e.google.com (mail-yw1-x112e.google.com [IPv6:2607:f8b0:4864:20::112e]) (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 4Ts0110bZ6z42bx for ; Fri, 8 Mar 2024 21:39:01 +0000 (UTC) (envelope-from christopher.davidson@gmail.com) Authentication-Results: mx1.freebsd.org; none Received: by mail-yw1-x112e.google.com with SMTP id 00721157ae682-609fc742044so19905767b3.1 for ; Fri, 08 Mar 2024 13:39:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1709933939; x=1710538739; darn=freebsd.org; h=mime-version:content-language:accept-language:in-reply-to :references:message-id:date:thread-index:thread-topic:subject:to :from:from:to:cc:subject:date:message-id:reply-to; bh=q9gANrxPoZ84seHJtD0TwiIC8z/WSdhdHEtoBRNgYo4=; b=d8sloFDL/1mb6nDE03PKmThK26ixSQp1jv1ghX609eeqHy0MkE1BfY542DQQNKHHDu 09L5HA4Y4M2kOwITSB8Go0GwA4f6rEwRAivntBO9Sfpz4fKRFNXt4y9VNrxLPLguOeKa 6CfjI1Ap90O5jJp/3aIw9qZ2Z9J/E6dduH4ALO3z7dPgY3+1tKagqxFnsRCSbzJR/V25 dStMZwTbHiZgSwCV9vpuFcXEMTIbcZTL2LsoLt30U/hgTlxhQVHIDY+xsnKs9UUN3qQ7 yW10Nk2KucHI4iWRAd/o7RAB/L6+efvoIE5I3Nj3cKQ3bJuEy1QblstRvyK8DkE0cpKR mldQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1709933939; x=1710538739; h=mime-version:content-language:accept-language:in-reply-to :references:message-id:date:thread-index:thread-topic:subject:to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=q9gANrxPoZ84seHJtD0TwiIC8z/WSdhdHEtoBRNgYo4=; b=CX2bhmru1xIXpP86q44aAu5+JAHrHw0djaEXVC3QULakYQ0Q0MFUFKY4zAn7zFzkIF ANDaRuKx/nFy4GhBqRNW2cen0owHq9L8nvdP/BSmk1K0q5clv8h8H/aB34aKLdNvZtN5 AaL9ygWFYK2ZlnQdH+V6fibipqLtipRWEdiAWT17vM9oNJcCdXLhXV/OzH2u58dVf0oD B7HrPMBg8bRKKD2oQXIGDSaD7fdKkousKru3Oc9O5B9udVYVbNduzQeXkzLidKn3L6GF kItNMa9sRtqPo33tbyVmcB2oIsC/oq8xUaCLA4sAorxx/qcOlJbOkl02Goegs2Q6NFlX Kwyg== X-Forwarded-Encrypted: i=1; AJvYcCV6VzW8glor3e7wP8AVYzytiqCagXzDaw1wyqU1E585mrboycaIFzmzT8Oc+cFPOU5DQJwy+Td30GaK/P0u08AvKm4t9mvOzw== X-Gm-Message-State: AOJu0YyRZDOK9NL+7XE17jftLyAD7ZzCwlYUraOPGLwbdP8W6xK3cEWo iMxRj81ShXbizaiW2O32gAlDZiPEoSdryuveCAgWgz8YCIJSDD5f9wQISjUK X-Google-Smtp-Source: AGHT+IEQ81E2vHfW538ATqhJKV2lJ+B86GKn4BQ6kFZVn0RIAujXnRPE5OqQ7tj5K1TDxF89Ky2UlQ== X-Received: by 2002:a05:622a:648:b0:42e:dfa6:bc0 with SMTP id a8-20020a05622a064800b0042edfa60bc0mr587675qtb.23.1709933094905; Fri, 08 Mar 2024 13:24:54 -0800 (PST) Received: from BN0PR20MB3750.namprd20.prod.outlook.com ([2603:1036:303:3818::5]) by smtp.gmail.com with ESMTPSA id df20-20020a05622a0ed400b0042eda5f783esm156839qtb.77.2024.03.08.13.24.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 08 Mar 2024 13:24:54 -0800 (PST) From: Christopher Davidson To: Alexander Ziaee , freebsd-doc Subject: Re: Question relationship of builting(1) and functions refrenced through .Xr Thread-Topic: Question relationship of builting(1) and functions refrenced through .Xr Thread-Index: AUxBMC1n0PifGUVPvOMKub4s6z6chJxg3Jqu X-MS-Exchange-MessageSentRepresentingType: 1 Date: Fri, 8 Mar 2024 21:24:54 +0000 Message-ID: References: In-Reply-To: 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_BN0PR20MB37501679FEEF7C3772505796A2272BN0PR20MB3750namp_" 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-Rspamd-Pre-Result: action=no action; module=replies; Message is reply to one we originated X-Spamd-Result: default: False [-4.00 / 15.00]; REPLY(-4.00)[]; TAGGED_FROM(0.00)[]; ASN(0.00)[asn:15169, ipnet:2607:f8b0::/32, country:US] X-Rspamd-Queue-Id: 4Ts0110bZ6z42bx --_000_BN0PR20MB37501679FEEF7C3772505796A2272BN0PR20MB3750namp_ Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi Alexander, That does give some clarity and do appreciate it. It looks like info(1) needs to go as a link.. I will submit a pull request. But this brings me to a larger question/possible issue: Is there a way to c= oordinate manual page updates? I see a lot of effort and guidance on the documentation portion but not man= ual pages. Kind Regards, Chris From: owner-freebsd-doc@freebsd.org on beha= lf of Alexander Ziaee Date: Friday, March 8, 2024 at 3:29 PM To: freebsd-doc Subject: Re: Question relationship of builting(1) and functions refrenced t= hrough .Xr Hi, (Chris Davidson asked) > How does the manual page relationship work > between the builtin(1) manual pages and the > individual .Xr links to other pages Builtin(1) describes shell builtin commands, but the links in this see also section refer to: - pages for valid, discrete programs in the base system with identical names to these builtin commands - the shells supplying the builtin commands - the link that you are looking for, info(1), which we had until FreeBSD 11 [0] and can probably be removed For example, I have a shell builtin 'which' and I also have a '/usr/bin/which'. I investigate suspicious links with that command and whereis(1), but I feel like I need to at least glance over the pages or it gets too meta. [0] https://man-dev.freebsd.org/FreeBSD-10.0-RELEASE/info.1 Hope this helps! Alexander Ziaee --_000_BN0PR20MB37501679FEEF7C3772505796A2272BN0PR20MB3750namp_ Content-Type: text/html; charset="us-ascii" Content-Transfer-Encoding: quoted-printable

Hi Alexander,<= /o:p>

 

That does give some= clarity and do appreciate it.

 

It looks like info(= 1) needs to go as a link.. I will submit a pull request.

 

But this brings me = to a larger question/possible issue: Is there a way to coordinate manual pa= ge updates?

 

I see a lot of effo= rt and guidance on the documentation portion but not manual pages.

 

Kind Regards,<= /o:p>

Chris

 

From: owner-freebsd-doc@freebsd.org <ow= ner-freebsd-doc@freebsd.org> on behalf of Alexander Ziaee <concussiou= s@runbox.com>
Date: Friday, March 8, 2024 at 3:29 PM
To: freebsd-doc <freebsd-doc@FreeBSD.org>
Subject: Re: Question relationship of builting(1) and functions refr= enced through .Xr

Hi,

(Chris Davidson asked)
> How does the manual page relationship work
> between the builtin(1) manual pages and the
> individual .Xr links to other pages

Builtin(1) describes shell builtin commands,
but the links in this see also section refer to:

- pages for valid, discrete programs in the base
system with identical names to these builtin commands

- the shells supplying the builtin commands

- the link that you are looking for, info(1), which we had
until FreeBSD 11 [0] and can probably be removed

For example, I have a shell builtin 'which' and I also
have a '/usr/bin/which'. I investigate suspicious links
with that command and whereis(1), but I feel like I need
to at least glance over the pages or it gets too meta.

[0] htt= ps://man-dev.freebsd.org/FreeBSD-10.0-RELEASE/info.1

Hope this helps!
Alexander Ziaee

--_000_BN0PR20MB37501679FEEF7C3772505796A2272BN0PR20MB3750namp_--