minor tweaks to the RfC system

- add 'asciidoc' operation to rfc.sh
- put 'pro', 'con' and 'alternatives' in a common section 'Discussion'
This commit is contained in:
Fischlurch 2010-12-13 04:46:05 +01:00
parent 7960ab5364
commit 1ce29b7d3c
2 changed files with 18 additions and 7 deletions

View file

@ -4,7 +4,7 @@ shopt -s extglob
function usage()
{
less -F <<"EOF"
less <<"EOF"
Script to maintain Lumiera RFC's
usage:
@ -22,6 +22,7 @@ commands (with <mandatory> and [optional] parameters):
show <rfcs> [regex] - Read RFC's (matching 'regex')
create <title> - Create a new RFC
edit <rfc> [chapter] - Edit RFC at chapter
asciidoc <rfc> - pass the rfc.txt to 'asciidoc' command
comment <rfc> - Add a new comment to a RFC
draft <rfc> - Change RFC to Draft state
final <rfc> - Change RFC to Final state
@ -237,7 +238,7 @@ function edit()
{
# filename lineoffset chapter
EDITOR="${EDITOR:-$(git config --get core.editor)}"
EDITOR="${EDITOR:-VISUAL}"
EDITOR="${EDITOR:-$VISUAL}"
local file="$1"
local line=0
@ -370,6 +371,12 @@ edit)
git add "$name"
fi
;;
asciidoc)
name=$(unique_name "$1")
if [[ "$name" ]]; then
asciidoc "${name}"
fi
;;
draft)
name=$(unique_name "$1")
if [[ "$name" ]]; then

14
doc/template/rfc.txt vendored
View file

@ -25,13 +25,17 @@ Description
Tasks
~~~~~
// List what would need to be done to implement this Proposal in a few words:
// * item ...
// List what needs to be done to implement this Proposal:
// * first step ([green]#✔ done#)
// * second step [,yellow]#WIP#
Discussion
~~~~~~~~~~
Pros
^^^^
// add just a fact list/enumeration which make this suitable:
// add a fact list/enumeration which make this suitable:
// * foo
// * bar ...
@ -44,14 +48,14 @@ Cons
Alternatives
------------
^^^^^^^^^^^^
//alternatives: explain alternatives and tell why they are not viable:
Rationale
---------
//rationale: Describe why it should be done *this* way:
//rationale: Give a concise summary why it should be done *this* way: