From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Philipp Stephani Newsgroups: gmane.emacs.devel Subject: Re: [PATCH] Use recommended long options syntax in man page Date: Wed, 17 Jan 2018 22:33:49 +0000 Message-ID: References: <20180107231238.76897-1-phst@google.com> <439239ad-5191-84a6-4c07-b34536ebd437@cs.ucla.edu> <245f0400-3234-3623-1085-d8be74c5bd04@cs.ucla.edu> <83608b6j3u.fsf@gnu.org> <2a79ab0b-9257-6653-f2e3-baed797346cf@cs.ucla.edu> <83mv1m5qrl.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="94eb2c1cd70c8c7d0405630071b0" X-Trace: blaine.gmane.org 1516228343 10301 195.159.176.226 (17 Jan 2018 22:32:23 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Wed, 17 Jan 2018 22:32:23 +0000 (UTC) Cc: Richard Copley , phst@google.com, eliz@gnu.org, eggert@cs.ucla.edu, emacs-devel@gnu.org To: rms@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Jan 17 23:32:18 2018 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ebwFb-0001rS-Pu for ged-emacs-devel@m.gmane.org; Wed, 17 Jan 2018 23:32:07 +0100 Original-Received: from localhost ([::1]:39474 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ebwHb-00040j-T2 for ged-emacs-devel@m.gmane.org; Wed, 17 Jan 2018 17:34:11 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48975) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ebwHV-00040N-BY for emacs-devel@gnu.org; Wed, 17 Jan 2018 17:34:06 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ebwHU-0000nQ-DV for emacs-devel@gnu.org; Wed, 17 Jan 2018 17:34:05 -0500 Original-Received: from mail-lf0-x243.google.com ([2a00:1450:4010:c07::243]:43473) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ebwHR-0000lk-Fr; Wed, 17 Jan 2018 17:34:01 -0500 Original-Received: by mail-lf0-x243.google.com with SMTP id o89so19901274lfg.10; Wed, 17 Jan 2018 14:34:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=EFwHx2OnFM9VUMU5CCwqVL6lgI2lxnoCYJb8sz/1MVk=; b=ntvaOJvHaocA2H8TtAP4cvjmQUz7+ASN2dlEh9AHXswajHxChul2d9Fx5NDOW2F0dg dW4T8Y/cAoGjK1+hRNZXUyWN7PE0AGxFYwMd+/wNHT4U3U9yeZlMXEZiLTFju/mXO8yz w5YVp/I9Z5dQL2x974KN7mlD4s2X1n5M/yS7crQVgXcTIJIU1BaIS6vO7zzDxXvwvTvo VUgRHmsOszFn6+vgCoEM2aUjJI0lVA1f0oQDnx6HZn7RV3Hl4nq8oEiCBbZcrSW0VaDl WSnnh3wLfJu+u6yIrl9MUIIieJduJiCDLAuUpJPNkKm1y+PT48489NDfItEwDQicGaKN CVpg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=EFwHx2OnFM9VUMU5CCwqVL6lgI2lxnoCYJb8sz/1MVk=; b=k8UPMhAgnmxm8wiZ5agpOwyU4qYdMDeWvMtyAflF0ow31DJwEeJexHHRJU+JUd6ibI RSx9GWDFKpPQSxQssKwav7KLdRz0KaNNq4BDDDETE7sQOJRayRSUSkWR1Rg0NUU13pzu iuN2TNUZXLs/ByttBI6hdtlpXZjezUYBlPpZZ3J96yDDFmy1fopgJzIXKpmFdyLRWnXY 9WPhN6Ok8YCoDIuUBJS6+wmVgGbnb6pTpid8w9hHydX6gllSDdR1Sj1ppI30RaxR2QaI 4g6JGWuIgA1PREP8rzllGtt4ixu+R6sSI+a2K9yVTQqDKM0NM3vsOxn+E8/z7z5iFdfR +hUQ== X-Gm-Message-State: AKwxytecRdvNtFQgQumjTUMbmktiYbiTMQI0TLz62t2oLn30XX40N8lS vrp1iVTq76FbwgSBylP82HbNmWtfBns0uixI3w3ExA== X-Google-Smtp-Source: ACJfBosU0A++Byly3WxKLiggkUyFflAweZ2YitBp8FXZWA54VWEuZerSTko2pClHHlZtodT67Gc4u/uTnrlUG+rUFgw= X-Received: by 10.25.171.10 with SMTP id u10mr21536629lfe.12.1516228439733; Wed, 17 Jan 2018 14:33:59 -0800 (PST) In-Reply-To: X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4010:c07::243 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:222061 Archived-At: --94eb2c1cd70c8c7d0405630071b0 Content-Type: text/plain; charset="UTF-8" Richard Stallman schrieb am Do., 11. Jan. 2018 um 20:51 Uhr: > [[[ To any NSA and FBI agents reading my email: please consider ]]] > [[[ whether defending the US Constitution against all enemies, ]]] > [[[ foreign or domestic, requires you to follow Snowden's example. ]]] > > > Both arguments have merit. Manuals aren't just for newbies. Maybe > > there's room to introduce the syntax with the = first, then elaborate > > explaining the actual syntax in full. Or maybe that level of detail is > > best left for the TexInfo manual. > > Please use = for long option arguments in the man page. > > I've pushed the patch that switches to = to emacs-26 (commit 779b2ac484). We can argue about what should be recommended, but at the very least the documentation should be consistent, and we either recommend or require = everywhere else in the Info manual and other man pages. --94eb2c1cd70c8c7d0405630071b0 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable


Richar= d Stallman <rms@gnu.org> schrieb a= m Do., 11. Jan. 2018 um 20:51=C2=A0Uhr:
[[[ To any NSA and FBI agents reading my email: please consider=C2=A0 = =C2=A0 ]]]
[[[ whether defending the US Constitution against all enemies,=C2=A0 =C2=A0= =C2=A0]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]<= br>
=C2=A0 > Both arguments have merit. Manuals aren't just for newbies.= Maybe
=C2=A0 > there's room to introduce the syntax with the =3D first, th= en elaborate
=C2=A0 > explaining the actual syntax in full. Or maybe that level of de= tail is
=C2=A0 > best left for the TexInfo manual.

Please use =3D for long option arguments in the man page.


I've pushed the patch that switches to= =3D to emacs-26 (commit 779b2ac484).
We can argue about what sho= uld be recommended, but at the very least the documentation should be consi= stent, and we either recommend or require =3D everywhere else in the Info m= anual and other man pages.=C2=A0
--94eb2c1cd70c8c7d0405630071b0--