unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: emacs-devel@gnu.org
Subject: Re: Indentation conventions for Info manuals; recognizing code
Date: Mon, 08 Mar 2021 00:37:21 -0500	[thread overview]
Message-ID: <E1lJ8a1-0000NR-Nl@fencepost.gnu.org> (raw)
In-Reply-To: <SA2PR10MB4474CB7322BEDE862DD42BBFF3949@SA2PR10MB4474.namprd10.prod.outlook.com> (message from Drew Adams on Sun, 7 Mar 2021 01:58:43 +0000)

[[[ 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. ]]]

The structure of an Info file is documented somewhere, but style
conventions are not.  The style conventions for Info files are defined
by what properly written Texinfo source converts into.

I did not write separate documentation for Info format because (1) it
would be more or less duplicative and (2) Info files are normally
generated from Texinfo files.

  > But other manuals don't seem to use the same indentation.  Several
  > (org, eintr, ccmode, efaq(-w32),...) indent code (including Elisp)
  > 5 spaces - which is the same amount that other, non-code text is
  > indented.

Aside from eintr, I don't know anything specific about those manuals.

The eintr manual was written by Bob Chassell; I presume it is still
generated from Texinfo, right?  So I find it puzzling that it produces
a different format in the Info file.  

Why does it do that?  Is the source formatted in an unusual way?  Does
it somehow specify different parameters for generating the Info file?

-- 
Dr Richard Stallman
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)





  parent reply	other threads:[~2021-03-08  5:37 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-07  1:58 Indentation conventions for Info manuals; recognizing code Drew Adams
2021-03-07  6:33 ` Eli Zaretskii
2021-03-08  3:47   ` [External] : " Drew Adams
2021-03-08  5:49     ` Yuri Khan
2021-03-08 14:07       ` Eli Zaretskii
2021-03-08 15:33       ` Drew Adams
2021-03-08  5:37 ` Richard Stallman [this message]
2021-03-08 13:57   ` Eli Zaretskii
2021-03-08 15:33   ` [External] : " Drew Adams
  -- strict thread matches above, loose matches on Subject: below --
2021-03-08  9:51 tydrdn

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=E1lJ8a1-0000NR-Nl@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).