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:
parent
7960ab5364
commit
1ce29b7d3c
2 changed files with 18 additions and 7 deletions
11
admin/rfc.sh
11
admin/rfc.sh
|
|
@ -4,7 +4,7 @@ shopt -s extglob
|
||||||
|
|
||||||
function usage()
|
function usage()
|
||||||
{
|
{
|
||||||
less -F <<"EOF"
|
less <<"EOF"
|
||||||
Script to maintain Lumiera RFC's
|
Script to maintain Lumiera RFC's
|
||||||
|
|
||||||
usage:
|
usage:
|
||||||
|
|
@ -22,6 +22,7 @@ commands (with <mandatory> and [optional] parameters):
|
||||||
show <rfcs> [regex] - Read RFC's (matching 'regex')
|
show <rfcs> [regex] - Read RFC's (matching 'regex')
|
||||||
create <title> - Create a new RFC
|
create <title> - Create a new RFC
|
||||||
edit <rfc> [chapter] - Edit RFC at chapter
|
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
|
comment <rfc> - Add a new comment to a RFC
|
||||||
draft <rfc> - Change RFC to Draft state
|
draft <rfc> - Change RFC to Draft state
|
||||||
final <rfc> - Change RFC to Final state
|
final <rfc> - Change RFC to Final state
|
||||||
|
|
@ -237,7 +238,7 @@ function edit()
|
||||||
{
|
{
|
||||||
# filename lineoffset chapter
|
# filename lineoffset chapter
|
||||||
EDITOR="${EDITOR:-$(git config --get core.editor)}"
|
EDITOR="${EDITOR:-$(git config --get core.editor)}"
|
||||||
EDITOR="${EDITOR:-VISUAL}"
|
EDITOR="${EDITOR:-$VISUAL}"
|
||||||
|
|
||||||
local file="$1"
|
local file="$1"
|
||||||
local line=0
|
local line=0
|
||||||
|
|
@ -370,6 +371,12 @@ edit)
|
||||||
git add "$name"
|
git add "$name"
|
||||||
fi
|
fi
|
||||||
;;
|
;;
|
||||||
|
asciidoc)
|
||||||
|
name=$(unique_name "$1")
|
||||||
|
if [[ "$name" ]]; then
|
||||||
|
asciidoc "${name}"
|
||||||
|
fi
|
||||||
|
;;
|
||||||
draft)
|
draft)
|
||||||
name=$(unique_name "$1")
|
name=$(unique_name "$1")
|
||||||
if [[ "$name" ]]; then
|
if [[ "$name" ]]; then
|
||||||
|
|
|
||||||
14
doc/template/rfc.txt
vendored
14
doc/template/rfc.txt
vendored
|
|
@ -25,13 +25,17 @@ Description
|
||||||
|
|
||||||
Tasks
|
Tasks
|
||||||
~~~~~
|
~~~~~
|
||||||
// List what would need to be done to implement this Proposal in a few words:
|
// List what needs to be done to implement this Proposal:
|
||||||
// * item ...
|
// * first step ([green]#✔ done#)
|
||||||
|
// * second step [,yellow]#WIP#
|
||||||
|
|
||||||
|
|
||||||
|
Discussion
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
Pros
|
Pros
|
||||||
^^^^
|
^^^^
|
||||||
// add just a fact list/enumeration which make this suitable:
|
// add a fact list/enumeration which make this suitable:
|
||||||
// * foo
|
// * foo
|
||||||
// * bar ...
|
// * bar ...
|
||||||
|
|
||||||
|
|
@ -44,14 +48,14 @@ Cons
|
||||||
|
|
||||||
|
|
||||||
Alternatives
|
Alternatives
|
||||||
------------
|
^^^^^^^^^^^^
|
||||||
//alternatives: explain alternatives and tell why they are not viable:
|
//alternatives: explain alternatives and tell why they are not viable:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Rationale
|
Rationale
|
||||||
---------
|
---------
|
||||||
//rationale: Describe why it should be done *this* way:
|
//rationale: Give a concise summary why it should be done *this* way:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue