From nobody Mon Jan 01 01:36:33 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 4T3JVV5pp6z55p9j for ; Mon, 1 Jan 2024 01:36:34 +0000 (UTC) (envelope-from kolusion@post.com) Received: from mout.gmx.com (mout.gmx.com [74.208.4.200]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "mout.gmx.com", Issuer "GeoTrust TLS RSA CA G1" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4T3JVT6G8fz4ZqY for ; Mon, 1 Jan 2024 01:36:33 +0000 (UTC) (envelope-from kolusion@post.com) Authentication-Results: mx1.freebsd.org; dkim=pass header.d=post.com header.s=s1089575 header.b=DaMNv+Ml; spf=pass (mx1.freebsd.org: domain of kolusion@post.com designates 74.208.4.200 as permitted sender) smtp.mailfrom=kolusion@post.com; dmarc=pass (policy=none) header.from=post.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=post.com; s=s1089575; t=1704072993; x=1704677793; i=kolusion@post.com; bh=uHE6MEf7GnT0c5WdfQHRJ+4hdAj1OWt8j6HgqRPUodY=; h=X-UI-Sender-Class:From:To:Subject:Date; b=DaMNv+Ml2KFI1Xn7UY/h77IK0/VQpCsQKUBr+CuzvynVuEcWAhjzWYz49WtEKpD0 Ec/MtO4OSy4NJu6TogRLJ25Cm2cQjmc531fMF7EVR5VSShm7NVbdfuQr9J6/aMLSj xUjx8prXkrs5IbeJ/vFaV4E7w2/buzpwowmJEbkdrFAvePU2V8mENSOFEeN78wQhq 2FWZYr/MVszIA0ch3x81DuWSGG1FJH/9Prw/1FIyx+5l67DUA425MECPzHcVkY6b8 9Yd/OiWFw5hv1XsX0Urn4uyfiak+FithZ6F3YZv+w5CJt9B/G+hekoDYNR1OrSHkF hQhDVBLH+Jm8LikOcw== X-UI-Sender-Class: f2cb72be-343f-493d-8ec3-b1efb8d6185a Received: from [10.237.66.2] ([10.237.66.2]) by msvc-mesg-gmxus008.server.lan (via HTTP); Mon, 1 Jan 2024 02:36:33 +0100 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 Message-ID: From: Kolusion K To: freebsd-doc@freebsd.org Subject: Inconsistent use of both flow of wording and terminology Content-Type: text/plain; charset=UTF-8 Importance: normal Sensitivity: Normal Date: Mon, 1 Jan 2024 02:36:33 +0100 X-Priority: 3 X-Provags-ID: V03:K1:+VMI5DS98VGvQRbVIGYJKIyN1KDw4fdk0AWkX0cRmBkgLZBYCUgdG92UAklP3E+evQx+e jNS7yBMVPuGCC9P1cqFTXF8SZN6cpMa07nnc0/JmRxbsYj9NJj0bBnrjuhmekA648aocT8PYtvQo TlVcbYfo1ZqrUFVG+c7Y9dxlHsAvBjvsfwdV7O4V4QW+nzZ0/7+M8KrpSlD3IBXgvz+vz3mEZW0P /7OjnMtqjnOZ3dk1DVx+5c1JKNHVPCNAiriC/7oS3b9GTn+QPek1GCKY27veZXlFiY0PpkjAJoY7 FU= X-Spam-Flag: NO UI-OutboundReport: notjunk:1;M01:P0:Z5vRdKkyAEI=;RRoCBo+d/qAiQUtm7UZrKVjjzHV NGcYYB6Lyd9rx/x9CLmaZ8lrpW/5Y3QLw6EOMm8u8TOiehrGECL9X2cOBeUScw4YHr65MiK/I 3ChZcuIswme+kwbqG7sNyrQH9fK6hZLstW4edwmgi9A8RvlFCNmnCI1RO4MvSqjwJQ2e9ksqr m93JUL4d4vWEPN+iLSU0YmagnOJ2sij+aLbcnLzSkiWN/jhyNr6PpL7eF0p5vinPUP9IQsbRE g3atteCbwUNtmMI2q6v1CSSRd1kApo9Y9bjUUg9mRe43CFfTUq5EoX8l1bwqzMxQnqu/h568z g3Le5SPEtFsPJOtY1AyVC5GmD4iA6Bibc13lrnIVhBIew7DLBa34lJwoy17Abp5U51vn9V1ve sjm10UQnxonIA+7UJ9iNMnCgoYTh6LhOq3Nmo8B4+VpDriVlJGzfRjZu+cJ6/ShA9WpNN9Z1H pwsCV+7J1gNeIL9MGIp91TZrUvPAwuMu4fLWHsWAZgpD57+md3KY5kBqreDOtgz/ACtnDus6W 3CPJLoHfJA11VN2PLZbWCHHYaZUQr2CqYsngoG20g6q/C94g5oywG2RG+kTwyVaWpd7ElHvbz pGiqRL03FF2sQ5rnHLvYwiCsE1gvn4wijmQ3mn0oDelx9uXRxXM5CzDiWnhMajYJC/2kaDfo9 jOOsQ5lAT55s5yaUqJCu1HKraRKbTcw2iSanXrJjruVSt9i65jE48P2F9LgcV8NZGICL6Mps/ lnjpIdlx5AGmFdUbPjCfVYUh1hlqcOhR8Y8p+vHAhtekUlhYEnqeo63IijiJ4GqZ7XCyLQOE+ NPTYqODq9yANwC/QFD0RMz38iZF4fuTAh1h7Eqp/oQkuM= X-Spamd-Result: default: False [-3.60 / 15.00]; NEURAL_HAM_LONG(-1.00)[-1.000]; NEURAL_HAM_MEDIUM(-1.00)[-1.000]; NEURAL_HAM_SHORT(-1.00)[-0.998]; MID_RHS_NOT_FQDN(0.50)[]; DMARC_POLICY_ALLOW(-0.50)[post.com,none]; R_DKIM_ALLOW(-0.20)[post.com:s=s1089575]; R_SPF_ALLOW(-0.20)[+ip4:74.208.4.192/26]; ONCE_RECEIVED(0.10)[]; MIME_GOOD(-0.10)[text/plain]; RCVD_IN_DNSWL_LOW(-0.10)[74.208.4.200:from]; RWL_MAILSPIKE_GOOD(-0.10)[74.208.4.200:from]; MIME_TRACE(0.00)[0:+]; TO_MATCH_ENVRCPT_ALL(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_NONE(0.00)[]; RCPT_COUNT_ONE(0.00)[1]; FREEMAIL_FROM(0.00)[post.com]; FROM_EQ_ENVFROM(0.00)[]; RCVD_TLS_LAST(0.00)[]; HAS_X_PRIO_THREE(0.00)[3]; MLMMJ_DEST(0.00)[freebsd-doc@freebsd.org]; DKIM_TRACE(0.00)[post.com:+]; ASN(0.00)[asn:8560, ipnet:74.208.0.0/16, country:DE]; ARC_NA(0.00)[]; RCVD_COUNT_ONE(0.00)[1]; FREEMAIL_ENVFROM(0.00)[post.com] X-Rspamd-Queue-Id: 4T3JVT6G8fz4ZqY X-Spamd-Bar: --- Hi, The FreeBSD Handbook inconsistently uses both the flow of wording and terminology when giving instructions. When I say the flow of wording, I mean syntax. Section 20.12.2. Setting Quota Limits states "To verify that quotas are enabled, run:". Section 20.13.1. Disk Encryption with gbde states "FreeBSD provides a kernel module for gbde which can be loaded with this command:". Section 20.14.1. Configuring Encrypted Swap states "To overwrite the current swap partition with random garbage, execute the following command:". 'run', 'with this command', 'execute the following command'... I think flow of wording should be used consistently because it helps users psychologically interpreting instructions more easily as they become more familiar and habitual with a consistent flow. I think terminology should be used consistently because some users may think for example that running and executing are two different things. And I think consistent use of both flow of wording and terminology makes the FreeBSD Handbook look more polished. I think 'run' is a better term than 'execute' because 'run' is a term used a lot more by people, especially verbally. And 'run' sounds a lot less nerdy than 'execute'. :) Sincerely, Kolusion