Skip to Content.
Sympa Menu

sm-grimoire - Re: [SM-Grimoire] depends / provides / History format

sm-grimoire AT lists.ibiblio.org

Subject: Discussion of Spells and Grimoire items

List archive

Chronological Thread  
  • From: Hamish Greig <hgreig AT bigpond.net.au>
  • To: Grimoire <sm-grimoire AT lists.ibiblio.org>
  • Subject: Re: [SM-Grimoire] depends / provides / History format
  • Date: Tue, 07 Oct 2003 22:17:36 +1000

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Tue, 7 Oct 2003 22:30, Jose Bernardo Silva wrote:
> Seems ok by me, just a couple of questions:
> 1 - "DATE NAME EMAIL
> * LIST OF FILES:" - you're not implying this is upped case, right?
> 2 - what about multiple lines descriptions of changes, idented with a tab
> is ok?
AND
On Tue, 7 Oct 2003 21:27, Geoffrey Derber wrote:
>I think I'd prefer:
>DATE NAME EMAIL
> * FILE: description of change
> * FILE: description of change
>
>maybe some combination of the two may be in order for cases where the
>change effects multiple files

I hope you both don't mind squashing you together like this :)

The DATE is hyphenated numeric (easier to read in a glance ?), NAME is the
name you already use in HISTORY, email is your email, unless someone says
otherwise they should each have a single space between them. But do we use
< > around email, use nothing or use some other delimiter ?
2003-10-07 hgg hgreig AT bigpond.net.au
OR
2003-10-07 hgg <hgreig AT bigpond.net.au>
For the rest of it both examples would be correct depending on the change.
* DETAILS: update to *latest* version
* BUILD: fix typo in message
OR
* DETAILS,BUILD,DEPENDS: add configure switches, alter depends
and UPDATED for bug # XXXX

SO all files touched get listed, they could get listed together if
appropriate
(like 3 files one bug)
or they get listed individually.
If we *also* need to create guidelines for when entries can be comma
seperated
and when they should be newlines then we can do that too.
I see a line space between each dated entry but not within each entry, like
this
2003-10-07 hgg hgreig AT bigpond.net.au
* DETAILS: blablabla

2003-10-06 hgg hgreig AT bigpond.net.au
* DEPENDS: blablabla
NOT this
2003-10-07 hgg hgreig AT bigpond.net.au

* DETAILS: blablabla

Lastly I dont really like upper-case letters (takes an extra keypress) unless
I am venting steam. But i really think our options for provides are limited.
We already know sorcery is case sensitive (hands up all those who found out
the hard way), including some special char would be silly, surrounding it by
"<'|{[delimiters]}|'>" would mean extra code in sorcery, using hyphenated
names would break half the grimoire so I think realistically we are only left
with
provides FOO
depends FOO

Any objections ?
Hamish

- --
IRC nick: drmoriarty
SMGL co-conspirator
#Do You SMGL!?
# Linux so advanced it may as well be magic!
# http://www.sourcemage.org/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (GNU/Linux)

iD8DBQE/gq7j8fSufZR6424RAl8nAJ4nOP+ygVgW31BKhh2MaxoYbA5pbACgkKMH
cdHr3WsNW6fwWg+N+sS7ZBA=
=/Ig5
-----END PGP SIGNATURE-----





Archive powered by MHonArc 2.6.24.

Top of Page