]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: encourage const in the developer doc 6478/head
authorMark Stapp <mjs@voltanet.io>
Thu, 28 May 2020 16:37:51 +0000 (12:37 -0400)
committerMark Stapp <mjs@voltanet.io>
Thu, 28 May 2020 16:37:51 +0000 (12:37 -0400)
Add a little text about using 'const' in the dev doc.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
doc/developer/workflow.rst

index 6885a41e0f4aeb4bd976a457b7af5fe739683171..49fa4fe83271c8e62e8b2df6d5aa78a51c8376b8 100644 (file)
@@ -1021,6 +1021,15 @@ JSON Output
 
 All JSON keys are to be camelCased, with no spaces.
 
+Use of const
+^^^^^^^^^^^^
+
+Please consider using ``const`` when possible: it's a useful hint to
+callers about the limits to side-effects from your apis, and it makes
+it possible to use your apis in paths that involve ``const``
+objects. If you encounter existing apis that *could* be ``const``,
+consider including changes in your own pull-request.
+
 
 .. _documentation: