From nobody Thu Sep 07 17:18:24 2023 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 4RhQtm3VQ3z4s9Hf for ; Thu, 7 Sep 2023 17:18:24 +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 4RhQtm1gdbz4Kr3 for ; Thu, 7 Sep 2023 17:18:24 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1694107104; a=rsa-sha256; cv=none; b=LS0MdMdYlA8XD5k7DnW6dAC4+bKvY2n9MN4gn1XqsMsVzZL7UzbJQQEjFSAcdH7OQuLGML pddJbvLehWm5e/aGHXpvEldrmH9bks+AtdC2e5/YEJEjW5S1/dit5m/Nhz9VIQJ+v511Wm +0HAMtExzdUdq80+JBGR/NAovqm7KYqYjWg7saDoRTYzWb6auUtvUN3bsjc9sK4bQKjohE BU+COFO5AW7NXF8utv03Nk2EozEnfaXBVRtsHl/qsVWrfRs0aq+ISGXxym0oAzF7xKsxI3 XtC4Y8R4w9Sgt++RGweMsxwR88eAsddJDq8cFmGj0e9tHEBGRzZanBZaT6EUTQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1694107104; 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=6RlXFGCsh7eO7iSs0FH02ReXbhYRmiUY3khEAesOIDI=; b=mS/NNRvRxizPa7NTMCpAOxJo7BhXR0/DO942+WM1pT7W8/5ZGfS1nycULL2Z/qUuE3ALQM 0KECiAIAFUrjTD1M508AWtauwAQ0vInHEH/U9vrYtV+FRumIEZiEz0HH5cvVFh+sHeaQzs E7Oxu9E5F4baoSPgaA6a+pHTzDmK9Xs3MPhlXR+bMT+9OKXktz+/SFdzCSYxOQsXMFNZwo 8mCIhDsjWSUE2jMs3S+S+XRMD71eIefQnkhjRg0SbM07p40ofx6nEsq013yNQcRCCwr4Pc NDRWUPkVNLmXFNuoszfKGIrQ2a3RpB2BJd4ruoNH6ehWj7awXc5pbaLuBc7EMA== 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 4RhQtm0dn7z17Lt for ; Thu, 7 Sep 2023 17:18:24 +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 387HIOCr091398 for ; Thu, 7 Sep 2023 17:18:24 GMT (envelope-from bugzilla-noreply@freebsd.org) Received: (from www@localhost) by kenobi.freebsd.org (8.15.2/8.15.2/Submit) id 387HIOwW091397 for doc@FreeBSD.org; Thu, 7 Sep 2023 17:18:24 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 273619] Committer's guide: potential for confusion with the currently given paths Date: Thu, 07 Sep 2023 17:18:24 +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: needs-patch X-Bugzilla-Severity: Affects Some People X-Bugzilla-Who: grahamperrin@gmail.com 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 bug_file_loc op_sys bug_status keywords bug_severity priority component assigned_to reporter 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 https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D273619 Bug ID: 273619 Summary: Committer's guide: potential for confusion with the currently given paths Product: Documentation Version: Latest Hardware: Any URL: https://github.com/freebsd/freebsd-doc/blob/main/docum entation/content/en/articles/committers-guide/_index.a doc#71-for-new-committers OS: Any Status: New Keywords: needs-patch Severity: Affects Some People Priority: --- Component: Books & Articles Assignee: doc@FreeBSD.org Reporter: grahamperrin@gmail.com In ste= p 1, it's not immediately clear that doc/ means the doc tree.=20 From step 5 and then step 9 it might be inferred that the first word in a p= ath represents a tree, however (to the best of my recollection) this approach is not commonplace.=20 In any case: inference is not ideal. Instead, be clear.=20 --=20 You are receiving this mail because: You are the assignee for the bug.=