From 1ce29b7d3c2fc76f3a791e56ea2df774d7fdaa24 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Mon, 13 Dec 2010 04:46:05 +0100 Subject: [PATCH] minor tweaks to the RfC system - add 'asciidoc' operation to rfc.sh - put 'pro', 'con' and 'alternatives' in a common section 'Discussion' --- admin/rfc.sh | 11 +++++++++-- doc/template/rfc.txt | 14 +++++++++----- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/admin/rfc.sh b/admin/rfc.sh index f360b7393..24f720d26 100755 --- a/admin/rfc.sh +++ b/admin/rfc.sh @@ -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 and [optional] parameters): show [regex] - Read RFC's (matching 'regex') create - 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 diff --git a/doc/template/rfc.txt b/doc/template/rfc.txt index b85efe175..0988835bd 100644 --- a/doc/template/rfc.txt +++ b/doc/template/rfc.txt @@ -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: