[opensuse-kernel] scripts/log: require an update of doc/config-options.changes for config changes
Hello Michal, Greg, Jeff, et. all-
This is sort of ugly and more of an RFC to see if it makes sense.
What do you all think?
Cheers,
Brandon
We have started tracking config changes in master in
doc/config-options.changes. Require that any config changes update that
file.
Signed-off-by: Brandon Philips
On 07/15/2010 11:43 AM, Brandon Philips wrote:
Hello Michal, Greg, Jeff, et. all-
This is sort of ugly and more of an RFC to see if it makes sense.
What do you all think?
Cheers,
Brandon
We have started tracking config changes in master in doc/config-options.changes. Require that any config changes update that file.
I thought that Jeff's idea was only to annotate differences from the Kconfig defaults. (Personally, I would even leave out all those "Enabled as module; defaults to n" and only document differences against allmodconfig, but I don't care much.)
Signed-off-by: Brandon Philips
--- scripts/log | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-)
--- a/scripts/log +++ b/scripts/log @@ -37,6 +37,22 @@ trap 'rm -rf "$tmpdir"' EXIT tmpdir=$(mktemp -d /tmp/${0##*/}.XXXXXX) message=$tmpdir/message
+config_log_entry() { + git diff doc/config-options.changes \ + | grep "^+[^+][^-]" \ + | tail +2 \ + | sed 's/^+//' \ + >> $tmpdir/configlog + + if [ ! -s $tmpdir/configlog ]; then + echo "ERROR: Config changes,"\ + "update doc/config-options.changes" >&2 + exit 1 + fi + + cat $tmpdir/configlog >> $message +} + log_entry() { local entry=$1
@@ -99,7 +115,7 @@ for file in "${files[@]}"; do case "$file" in config/*) if [ -z "$configs_updated" ]; then - log_entry "Update config files." + config_log_entry configs_updated=1 fi ;;
-- To unsubscribe, e-mail: opensuse-kernel+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-kernel+help@opensuse.org
On 07/15/2010 07:14 PM, Michal Marek wrote:
On 07/15/2010 11:43 AM, Brandon Philips wrote:
Hello Michal, Greg, Jeff, et. all-
This is sort of ugly and more of an RFC to see if it makes sense.
What do you all think?
Cheers,
Brandon
We have started tracking config changes in master in doc/config-options.changes. Require that any config changes update that file.
I thought that Jeff's idea was only to annotate differences from the Kconfig defaults.
(Personally, I would even leave out all those "Enabled as module; defaults to n" and only document differences against allmodconfig, but I don't care much.)
I was documenting all the changes. That way it features both as a config option change list and a new features list. Both are things that people have been asking for. -Jeff
Signed-off-by: Brandon Philips
--- scripts/log | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-)
--- a/scripts/log +++ b/scripts/log @@ -37,6 +37,22 @@ trap 'rm -rf "$tmpdir"' EXIT tmpdir=$(mktemp -d /tmp/${0##*/}.XXXXXX) message=$tmpdir/message
+config_log_entry() { + git diff doc/config-options.changes \ + | grep "^+[^+][^-]" \ + | tail +2 \ + | sed 's/^+//' \ + >> $tmpdir/configlog + + if [ ! -s $tmpdir/configlog ]; then + echo "ERROR: Config changes,"\ + "update doc/config-options.changes" >&2 + exit 1 + fi + + cat $tmpdir/configlog >> $message +} + log_entry() { local entry=$1
@@ -99,7 +115,7 @@ for file in "${files[@]}"; do case "$file" in config/*) if [ -z "$configs_updated" ]; then - log_entry "Update config files." + config_log_entry configs_updated=1 fi ;;
-- Jeff Mahoney SuSE Labs -- To unsubscribe, e-mail: opensuse-kernel+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-kernel+help@opensuse.org
On 19:14 Thu 15 Jul 2010, Michal Marek wrote:
On 07/15/2010 11:43 AM, Brandon Philips wrote:
We have started tracking config changes in master in doc/config-options.changes. Require that any config changes update that file.
I thought that Jeff's idea was only to annotate differences from the Kconfig defaults.
I think the idea was to document all CONFIG_ options coming and going from our Kernel flavors. Although, I will let Jeff speak for himself. Jeff? Despite the exact semantics of the changelog use does this change to scripts/log make sense? Thanks, Brandon
(Personally, I would even leave out all those "Enabled as module; defaults to n" and only document differences against allmodconfig, but I don't care much.)
Signed-off-by: Brandon Philips
--- scripts/log | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-)
--- a/scripts/log +++ b/scripts/log @@ -37,6 +37,22 @@ trap 'rm -rf "$tmpdir"' EXIT tmpdir=$(mktemp -d /tmp/${0##*/}.XXXXXX) message=$tmpdir/message
+config_log_entry() { + git diff doc/config-options.changes \ + | grep "^+[^+][^-]" \ + | tail +2 \ + | sed 's/^+//' \ + >> $tmpdir/configlog + + if [ ! -s $tmpdir/configlog ]; then + echo "ERROR: Config changes,"\ + "update doc/config-options.changes" >&2 + exit 1 + fi + + cat $tmpdir/configlog >> $message +} + log_entry() { local entry=$1
@@ -99,7 +115,7 @@ for file in "${files[@]}"; do case "$file" in config/*) if [ -z "$configs_updated" ]; then - log_entry "Update config files." + config_log_entry configs_updated=1 fi ;;
-- To unsubscribe, e-mail: opensuse-kernel+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-kernel+help@opensuse.org
-- To unsubscribe, e-mail: opensuse-kernel+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-kernel+help@opensuse.org
participants (3)
-
Brandon Philips -
Jeff Mahoney -
Michal Marek