From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Jean-Christophe Helary Newsgroups: gmane.emacs.devel Subject: Re: Common Lisp Emulation vs Common Lisp Extensions Date: Mon, 30 May 2016 14:33:47 +0900 Message-ID: <6DF2DAEE-D008-41CA-AD9B-4CDD275B2F3C@gmail.com> References: <1E868375-1773-40FB-95F5-2E141BA7CCCA@gmail.com> <83r3cmxjf3.fsf@gnu.org> <8360twyjvn.fsf@gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 (Mac OS X Mail 9.3 \(3124\)) Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1464592350 18376 80.91.229.3 (30 May 2016 07:12:30 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 30 May 2016 07:12:30 +0000 (UTC) To: emacs-devel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon May 30 09:12:26 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1b7HNC-0004al-51 for ged-emacs-devel@m.gmane.org; Mon, 30 May 2016 09:12:26 +0200 Original-Received: from localhost ([::1]:58238 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1b7HNB-0000wg-0s for ged-emacs-devel@m.gmane.org; Mon, 30 May 2016 03:12:25 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50424) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1b7HM6-0000qE-K0 for emacs-devel@gnu.org; Mon, 30 May 2016 03:11:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1b7HLx-00020w-TP for emacs-devel@gnu.org; Mon, 30 May 2016 03:11:13 -0400 Original-Received: from mail-pa0-x244.google.com ([2607:f8b0:400e:c03::244]:34440) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1b7HLx-00020p-Ik for emacs-devel@gnu.org; Mon, 30 May 2016 03:11:09 -0400 Original-Received: by mail-pa0-x244.google.com with SMTP id x1so4139868pav.1 for ; Mon, 30 May 2016 00:11:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:subject:from:in-reply-to:date :content-transfer-encoding:message-id:references:to; bh=nww+8Cif6cmsXMcoD+3QK9iA+JYFUKArbXGTeIoSumQ=; b=WTsayaNtFTPqRUtWuLmOthSF+Esvo3KXsgnVtzL5t3Vse3wtHy1zlmLQ87TF+d4YEo Ng4PSsPAe+U9SjEymsLj02ty8/CDQtDsN/iXeUKAEMZvh31PcjsaAHVTCza5ocpiXfVZ lGuepNJD8ia4SlQfmbmW2eiRhKYmIkokwjfjpZIKBIasMdVEFa9A3PtwNE1Pwapo+Pns fbOvtba3CGFfYITGqA/z4yN7aAVOZY0Qcm+vbGerQPOsuPobmscwcDwrspDw4o0QUtwK 7WGpeDvMpZCgFcVdWCImqLQC41lXQrSeYIRQjj8LCMbNUmzwhcLspGJHuy69Kq00dmaA iMQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date :content-transfer-encoding:message-id:references:to; bh=nww+8Cif6cmsXMcoD+3QK9iA+JYFUKArbXGTeIoSumQ=; b=AeeAwb8vrRIaLpiNkNahNNj2gmwKy+DCSGSQaV3O136JRFxZglE6dtM8gbcnyXfHzW 5DN0B/D5r3r1f/zhgB6ivtmLevBOj7vAicI4bPqMwR8mDBxRzAkazk60Wj71C19f+Ti0 gThbkbeuQYRZpLZ6069W9a4jkj291JV6HeRdy9poLAab15VJba0NYju1u+3SGkbynPot qQmVh7L9oq83e0wVs0MgmonhMfv3t3iyVFCcE08fJFYdpd5m/z18SWO7EdmCYbn79Snc 17IMaPlpnfecAXg2Kf9TixvgZ58OeFxXS89ZckZVjiCVsmoa3JEtkZodZkzZfu9DPfj0 UWhg== X-Gm-Message-State: ALyK8tLgME5D6qELlLs9CWXajkigbSQib3pSFKhVb3Ovaleu7EErH8OLZsMUsotPTwMvig== X-Received: by 10.66.191.100 with SMTP id gx4mr44940817pac.128.1464592268484; Mon, 30 May 2016 00:11:08 -0700 (PDT) Original-Received: from [10.254.2.138] ([210.160.37.45]) by smtp.gmail.com with ESMTPSA id 74sm30230474pfv.8.2016.05.30.00.11.06 for (version=TLS1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 30 May 2016 00:11:07 -0700 (PDT) In-Reply-To: <8360twyjvn.fsf@gnu.org> X-Mailer: Apple Mail (2.3124) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2607:f8b0:400e:c03::244 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:204138 Archived-At: Maybe my first mail was confusing so let me restart the discussion from = scratch. I've checked the texi sources for the CL manual, the Emacs = manual and the Elisp reference and the main discrepancy I find is the = following (which explains the issue I had finding the CL references): 1) CL manual The info source is: @settitle Common Lisp Extensions and @ifnottex @node Top @top GNU Emacs Common Lisp Emulation 2) Emacs manual The info source is: @settitle GNU Emacs Manual and @ifnottex @node Top @top The Emacs Editor=20 3) Elisp reference The info source is: @settitle GNU Emacs Lisp Reference Manual and @ifnottex @node Top @top Emacs Lisp If we consider that the Emacs manual and the Elisp reference set a = practice standard, the CL manual should use the following source: @settitle GNU Emacs Common Lisp Emulation and @ifnottex @node Top @top Common Lisp Extensions Also, (after checking the manual) since *extensions* to the Common Lisp = standard are only a small part of the CL manual contents, "Common Lisp = Extensions" should be reworded as "Common Lisp Emulation", and that = would increase the consistency in the whole documentation. So, let's suppose the CL manual follows that suggestion: @settitle GNU Emacs Common Lisp Emulation and @ifnottex @node Top @top Common Lisp Emulation The only pointer to the CL manual in the Emacs manual could be written = as: @xref{Top,,Overview,cl,GNU Emacs Common Lisp Emulation} and be rendered in info as: See Overview(cl) and in PDF as: See Section Overview in GNU Emacs Common Lisp Emulation and the 6 Elisp Reference pointers to the CL manual could similarly be = rewritten as: @xref{Section Name,,,cl,GNU Emacs Common Lisp Emulation} for a PDF rendering of: See Section =E2=80=9CSection Name=E2=80=9D in GNU Emacs Common = Lisp Emulation and in info: See Section Name(cl) "Common Lisp Emulation" would be used as the main title in the HTML (as =

), and as the info top page title. Last but not least, the info manual top node displays: * CL Partial Common Lisp support for Emacs Lisp. which comes from: @direntry * CL: (cl). Partial Common Lisp support for = Emacs Lisp. @end direntry Could be changed to "Partial Common Lisp emulation for Emacs Lisp" to = increase consistency. On a side note regarding that info manual top node, the entries are = really not consistent. * Org Mode Outline-based notes management and organizer =E2=86=92 does not end with a period * Emacs The extensible self-documenting text editor. =E2=86=92 we know what Emacs is, is the document the manual or not ? * Emacs FAQ Frequently Asked Questions about Emacs. =E2=86=92 good enough * Elisp The Emacs Lisp Reference Manual. =E2=86=92 good enough * Emacs Lisp Intro A simple introduction to Emacs Lisp programming. =E2=86=92 good enough * Ada mode Emacs mode for editing and compiling Ada code. =E2=86=92 we know it is a mode and that it is for Emacs, also the mode = does not "compile" since it requires an external compiler * CC Mode Emacs mode for editing C, C++, Objective-C, Java, Pike, AWK, and CORBA IDL code. =E2=86=92 we know it is an Emacs mode etc. It would be good to have general rules for Emacs related documentation = to add consistency to the set. Jean-Christophe=