Date: Fri, 21 Mar 2014 07:48:40 -0600 (MDT) From: Warren Block <wblock@wonkity.com> To: =?ISO-8859-15?Q?Dag-Erling_Sm=F8rgrav?= <des@des.no> Cc: jilles@freebsd.org, freebsd-current@freebsd.org, Mariusz Zaborski <oshogbo@freebsd.org>, freebsd-arch@freebsd.org Subject: Re: Hello fdclose Message-ID: <alpine.BSF.2.00.1403210740240.13682@wonkity.com> In-Reply-To: <86zjkkr5ma.fsf@nine.des.no> References: <CAGOYWV80vTTQbvSjvNa6XBzBiKy%2BjnGantkUH_RO=8prxoHmyQ@mail.gmail.com> <201403181404.52197.jhb@freebsd.org> <alpine.BSF.2.00.1403182230140.45496@wonkity.com> <201403191523.33275.jhb@freebsd.org> <alpine.BSF.2.00.1403191407240.52822@wonkity.com> <86zjkkr5ma.fsf@nine.des.no>
next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, 20 Mar 2014, Dag-Erling Smørgrav wrote: > Warren Block <wblock@wonkity.com> writes: >> John Baldwin <jhb@freebsd.org> writes: >>> Warren Block <wblock@wonkity.com> writes: >>>> .Fn fdclose >>>> is equivalent to >>>> .Fn fclose , >>>> but the file descriptor is returned rather than closed. >>> Yes, but this has the 'no capital letter at the start of a sentence' >>> problem. >> I've heard that mentioned before, but have never seen any actual rule >> regarding it. And we do have actual rules about avoiding redundant >> phrases: >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/book.html#writing-style-guidelines > > We always use > > The > .Nm foo > utility > > or > > The > .Fn foo > function > > instead of just .Nm or .Fn at the start of a sentence, but never (or > rarely) within a sentence. By "we", do you mean the FreeBSD project or your local organization? Is there a specific reason the redundant wording, or is it just customary? I suspect that usage is similar to that for an acronym, defining it on the first usage but only then. Both mdoc and DocBook markup should accomplish the same thing. From owner-freebsd-current@FreeBSD.ORG Fri Mar 21 14:19:05 2014 Return-Path: <owner-freebsd-current@FreeBSD.ORG> Delivered-To: freebsd-current@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id F1641EF2; Fri, 21 Mar 2014 14:19:04 +0000 (UTC) Received: from smtp.des.no (smtp.des.no [194.63.250.102]) by mx1.freebsd.org (Postfix) with ESMTP id AB361F27; Fri, 21 Mar 2014 14:19:04 +0000 (UTC) Received: from nine.des.no (smtp.des.no [194.63.250.102]) by smtp-int.des.no (Postfix) with ESMTP id A64EB6DAE; Fri, 21 Mar 2014 14:19:03 +0000 (UTC) Received: by nine.des.no (Postfix, from userid 1001) id C67577FB; Fri, 21 Mar 2014 15:18:52 +0100 (CET) From: =?utf-8?Q?Dag-Erling_Sm=C3=B8rgrav?= <des@des.no> To: Warren Block <wblock@wonkity.com> Subject: Re: Hello fdclose References: <CAGOYWV80vTTQbvSjvNa6XBzBiKy+jnGantkUH_RO=8prxoHmyQ@mail.gmail.com> <201403181404.52197.jhb@freebsd.org> <alpine.BSF.2.00.1403182230140.45496@wonkity.com> <201403191523.33275.jhb@freebsd.org> <alpine.BSF.2.00.1403191407240.52822@wonkity.com> <86zjkkr5ma.fsf@nine.des.no> <alpine.BSF.2.00.1403210740240.13682@wonkity.com> Date: Fri, 21 Mar 2014 15:18:52 +0100 In-Reply-To: <alpine.BSF.2.00.1403210740240.13682@wonkity.com> (Warren Block's message of "Fri, 21 Mar 2014 07:48:40 -0600 (MDT)") Message-ID: <86fvmbzlbn.fsf@nine.des.no> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (berkeley-unix) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Cc: jilles@freebsd.org, freebsd-current@freebsd.org, Mariusz Zaborski <oshogbo@freebsd.org>, freebsd-arch@freebsd.org X-BeenThere: freebsd-current@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: Discussions about the use of FreeBSD-current <freebsd-current.freebsd.org> List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-current>, <mailto:freebsd-current-request@freebsd.org?subject=unsubscribe> List-Archive: <http://lists.freebsd.org/pipermail/freebsd-current/>; List-Post: <mailto:freebsd-current@freebsd.org> List-Help: <mailto:freebsd-current-request@freebsd.org?subject=help> List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-current>, <mailto:freebsd-current-request@freebsd.org?subject=subscribe> X-List-Received-Date: Fri, 21 Mar 2014 14:19:05 -0000 Warren Block <wblock@wonkity.com> writes: > Dag-Erling Sm=C3=B8rgrav <des@des.no> writes: > > We always use [The .Nm foo utility or The .Fn foo function] instead > > of just .Nm or .Fn at the start of a sentence, but never (or rarely) > > within a sentence. > By "we", do you mean the FreeBSD project or your local organization? > Is there a specific reason the redundant wording, or is it just > customary? I mean the FreeBSD project, and the reason is as John stated: all sentences must start with a capital letter. I've gotten so used to this over the past 15 years that I even do it in email and other non-FreeBSD written material. DES --=20 Dag-Erling Sm=C3=B8rgrav - des@des.no
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.BSF.2.00.1403210740240.13682>