From: Thorsten Jolitz <tjolitz@gmail.com>
To: emacs-devel@gnu.org
Subject: Re: Modern conventions for structuring Emacs Lisp libraries
Date: Sun, 06 Oct 2013 18:51:28 +0200 [thread overview]
Message-ID: <87zjqme41b.fsf@gmail.com> (raw)
In-Reply-To: E1VSV5J-0003Tu-EW@fencepost.gnu.org
Richard Stallman <rms@gnu.org> writes:
> [ 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.
>
> Regarding the file keywords, the change you've proposed has some fatal
> flaws.
>
> | ;; ** MetaData
> | ;; :PROPERTIES:
> | ;; :copyright: Thorsten_Jolitz
> | ;; :copyright-since: 2013
> | ;; :version: 0.9
> | ;; :licence: GPL3+
> | ;; :licence-url: http://www.gnu.org/licenses/
>
> It is legally inadequate, since it doesn't have a standard copyright
> notice. A standard copyright notice looks like
>
> Copyright YEARS NAME
>
> It is inadequate for informing users about their rights, and the lack
> of warranty, and about our philosophy, because it lacks the explicit
> license notice which states those things. It may also be legally
> insufficient for making the license clear.
>
> We want people to see these words in the source file:
>
> | ;; This file is part of GNU Emacs.
> |
> | ;; GNU Emacs is free software: you can redistribute it and/or modify
> | ;; it under the terms of the GNU General Public License as published by
> | ;; the Free Software Foundation, either version 3 of the License, or
> | ;; (at your option) any later version.
> |
> | ;; GNU Emacs is distributed in the hope that it will be useful,
> | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
> | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> | ;; GNU General Public License for more details.
> |
> | ;; You should have received a copy of the GNU General Public License
> | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
>
> This part has to be kept as it is.
>
> Those issues don't apply to the library header lines:
>
> | ;; Maintainer: FSF
> | ;; Keywords: help, internal
> | ;; Package: emacs
>
> We could change them if it is an improvement. However, I think your
> format is worse for humans. We should not make it worse for humans
> just to cater to programs that some people use. You can change the
> programs instead.
Indeed, until now I did not get much positive feedback about the looks
of these property drawers in Elisp libraries, not even from Org-mode
users - although they seem to be more suited for meta-data than just
free text from a conceptual point of view.
What would be really helpful, besides saner official recommendations for
file structuring, would be an up-to-date official template for this
meta-data section (maybe there is one out there but I missed it?).
(Private) tools could then convert this template into (e.g.) easy to
handle Org-mode syntax like above, and convert them back to more human
readable traditional syntax before a library is added to some repo.
--
cheers,
Thorsten
next prev parent reply other threads:[~2013-10-06 16:51 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-05 13:31 Modern conventions for structuring Emacs Lisp libraries Thorsten Jolitz
2013-10-05 16:52 ` Richard Stallman
2013-10-06 16:40 ` Thorsten Jolitz
2013-10-06 18:04 ` Stefan Monnier
2013-10-07 0:36 ` Xue Fuqiao
2013-10-05 16:52 ` Richard Stallman
2013-10-05 19:18 ` Daniel Colascione
2013-10-06 8:20 ` legalese haters club Stephen J. Turnbull
2013-10-06 19:21 ` Modern conventions for structuring Emacs Lisp libraries Richard Stallman
2013-10-06 16:51 ` Thorsten Jolitz [this message]
2013-10-06 18:07 ` Stefan Monnier
2013-10-06 0:42 ` Stefan Monnier
2013-10-06 3:20 ` Xue Fuqiao
2013-10-06 4:47 ` Drew Adams
2013-10-06 17:42 ` Thorsten Jolitz
2013-10-06 18:13 ` Stefan Monnier
2013-10-06 19:31 ` Josh
2013-10-06 19:58 ` Pascal J. Bourguignon
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zjqme41b.fsf@gmail.com \
--to=tjolitz@gmail.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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.