summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2017-05-20 08:51:55 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2017-05-20 14:46:47 +0200
commite3f5a96c9fbb5a44d4ca83848ec5ad97df2ecf15 (patch)
tree50e315f73d23eabba63adc11552f45e5258dc76f
parentb79e0d10de34ab995bdad56f6017f76dc8f46564 (diff)
downloadgnutls-e3f5a96c9fbb5a44d4ca83848ec5ad97df2ecf15.tar.gz
documented the make files-update make option
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
-rw-r--r--CONTRIBUTING.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2c97025d7b..4b120ba7f1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -160,6 +160,14 @@ The NDEBUG macro is not used in GnuTLS compilation, so the assert() macros
are always active.
+# Auto-generated files:
+ Several parts of the documentation and the command line tools parameters
+files (.def) are auto-generated. Normally when introducing new functions,
+or adding new command line options to tools you need to run 'make
+files-update', review the output (when feasible) and commit it separately,
+e.g., with a message: "auto-generated files update".
+
+
# Guile bindings:
Parts of the Guile bindings, such as types (aka. "SMOBs"), enum values,