]>
Commit | Line | Data |
---|---|---|
9de103f0 QY |
1 | .. _process-and-workflow: |
2 | ||
3 | ******************* | |
b22ba015 | 4 | Process & Workflow |
9de103f0 | 5 | ******************* |
d1890d04 | 6 | |
b6820993 QY |
7 | .. highlight:: none |
8 | ||
b22ba015 QY |
9 | FRR is a large project developed by many different groups. This section |
10 | documents standards for code style & quality, commit messages, pull requests | |
11 | and best practices that all contributors are asked to follow. | |
d1890d04 | 12 | |
9de103f0 QY |
13 | This chapter is "descriptive/post-factual" in that it documents pratices that |
14 | are in use; it is not "definitive/pre-factual" in prescribing practices. This | |
b22ba015 QY |
15 | means that when a procedure changes, it is agreed upon, then put into practice, |
16 | and then documented here. If this document doesn't match reality, it's the | |
17 | document that needs to be updated, not reality. | |
d1890d04 | 18 | |
9de103f0 QY |
19 | Mailing Lists |
20 | ============= | |
d1890d04 | 21 | |
b22ba015 QY |
22 | The FRR development group maintains multiple mailing lists for use by the |
23 | community. Italicized lists are private. | |
d1890d04 QY |
24 | |
25 | +----------------------------------+--------------------------------+ | |
26 | | Topic | List | | |
27 | +==================================+================================+ | |
28 | | Development | dev@lists.frrouting.org | | |
29 | +----------------------------------+--------------------------------+ | |
30 | | Users & Operators | frog@lists.frrouting.org | | |
31 | +----------------------------------+--------------------------------+ | |
32 | | Announcements | announce@lists.frrouting.org | | |
33 | +----------------------------------+--------------------------------+ | |
34 | | *Security* | security@lists.frrouting.org | | |
35 | +----------------------------------+--------------------------------+ | |
36 | | *Technical Steering Committee* | tsc@lists.frrouting.org | | |
37 | +----------------------------------+--------------------------------+ | |
38 | ||
9de103f0 | 39 | The Development list is used to discuss and document general issues related to |
b6820993 QY |
40 | project development and governance. The public |
41 | `Slack instance <https://frrouting.slack.com>`_ and weekly technical meetings | |
42 | provide a higher bandwidth channel for discussions. The results of such | |
43 | discussions must be reflected in updates, as appropriate, to code (i.e., | |
44 | merges), `GitHub issues`_, and for governance or process changes, updates to | |
45 | the Development list and either this file or information posted at | |
46 | https://frrouting.org/. | |
47 | ||
48 | Development & Release Cycle | |
49 | =========================== | |
50 | ||
51 | Development | |
52 | ----------- | |
53 | ||
54 | .. figure:: ../figures/git_branches.png | |
55 | :align: center | |
56 | :scale: 55% | |
57 | :alt: Merging Git branches into a central trunk | |
58 | ||
59 | Rough outline of FRR development workflow | |
60 | ||
61 | The master Git for FRR resides on `GitHub`_. | |
62 | ||
63 | There is one main branch for development, ``master``. For each major release | |
64 | (2.0, 3.0 etc) a new release branch is created based on the master. Significant | |
65 | bugfixes should be backported to upcoming and existing release branches no more | |
66 | than 1 year old. As a general rule new features are not backported to release | |
67 | branches. | |
8ce7861f | 68 | |
b6820993 | 69 | Subsequent point releases based on a major branch are handled with git tags. |
c804874a | 70 | |
b6820993 QY |
71 | Releases |
72 | -------- | |
73 | FRR employs a ``<MAJOR>.<MINOR>.<BUGFIX>`` versioning scheme. | |
c804874a | 74 | |
b6820993 | 75 | ``MAJOR`` |
ac97970d DL |
76 | Significant new features or multiple minor features. This should mostly |
77 | cover any kind of disruptive change that is visible or "risky" to operators. | |
78 | New features or protocols do not necessarily trigger this. (This was changed | |
79 | for FRR 7.x after feedback from users that the pace of major version number | |
80 | increments was too high.) | |
c804874a | 81 | |
b6820993 | 82 | ``MINOR`` |
ac97970d DL |
83 | General incremental development releases, excluding "major" changes |
84 | mentioned above. Not necessarily fully backwards compatible, as smaller | |
85 | (but still visible) changes or deprecated feature removals may still happen. | |
86 | However, there shouldn't be any huge "surprises" between minor releases. | |
c804874a | 87 | |
b6820993 | 88 | ``BUGFIX`` |
ac97970d | 89 | Fixes for actual bugs and/or security issues. Fully compatible. |
c804874a QY |
90 | |
91 | We will pull a new development branch for the next release every 4 months. The | |
b6820993 QY |
92 | current schedule is Feb/June/October 1. The decision for a ``MAJOR/MINOR`` |
93 | release is made at the time of branch pull based on what has been received the | |
94 | previous 4 months. The branch name will be ``dev/MAJOR.MINOR``. At this point | |
95 | in time the master branch and this new branch, :file:`configure.ac`, | |
96 | documentation and packaging systems will be updated to reflect the next | |
97 | possible release name to allow for easy distinguishing. | |
98 | ||
99 | After one month the development branch will be renamed to | |
bd2b4fc3 PG |
100 | ``stable/MAJOR.MINOR``. The branch is a stable branch. This process is not |
101 | held up unless a crash or security issue has been found and needs to | |
102 | be addressed. Issues being fixed will not cause a delay. | |
c804874a QY |
103 | |
104 | Bugfix releases are made as needed at 1 month intervals until the next | |
bd2b4fc3 | 105 | ``MAJOR.MINOR`` release branch is pulled. Depending on the severity of the bugs, |
c804874a QY |
106 | bugfix releases may occur sooner. |
107 | ||
07ff01d2 PG |
108 | Bugfixes are applied to the two most recent releases. However, backporting of bug |
109 | fixes to older than the two most recent releases will not be prevented, if acked | |
110 | under the classical development workflow applying for a pull request. | |
111 | ||
112 | Security fixes are backported to all releases less than or equal to at least one | |
113 | year old. Security fixes may also be backported to older releases depending on | |
114 | severity. | |
115 | ||
f4bcc72f QY |
116 | For detailed instructions on how to produce an FRR release, refer to |
117 | :ref:`frr-release-procedure`. | |
118 | ||
bd2b4fc3 PG |
119 | |
120 | Long term support branches ( LTS ) | |
121 | ----------------------------------------- | |
122 | ||
123 | This kind of branch is not yet officially supported, and need experimentation | |
124 | before being effective. | |
125 | ||
126 | Previous definition of releases prevents long term support of previous releases. | |
127 | For instance, bug and security fixes are not applied if the stable branch is too | |
128 | old. | |
129 | ||
130 | Because the FRR users have a need to backport bug and security fixes after the | |
131 | stable branch becomes too old, there is a need to provide support on a long term | |
132 | basis on that stable branch. If that support is applied on that stable branch, | |
133 | then that branch is a long term support branch. | |
134 | ||
135 | Having a LTS branch requires extra-work and requires one person to be in charge | |
136 | of that maintenance branch for a certain amount of time. The amount of time will | |
137 | be by default set to 4 months, and can be increased. 4 months stands for the time | |
138 | between two releases, this time can be applied to the decision to continue with a | |
139 | LTS release or not. In all cases, that time period will be well-defined and | |
140 | published. Also, a self nomination from a person that proposes to handle the LTS | |
141 | branch is required. The work can be shared by multiple people. In all cases, there | |
142 | must be at least one person that is in charge of the maintenance branch. The person | |
143 | on people responsible for a maintenance branch must be a FRR maintainer. Note that | |
144 | they may choose to abandon support for the maintenance branch at any time. If | |
56f0bea7 | 145 | no one takes over the responsibility of the LTS branch, then the support will be |
bd2b4fc3 PG |
146 | discontinued. |
147 | ||
148 | The LTS branch duties are the following ones: | |
149 | ||
150 | - organise meetings on a (bi-)weekly or monthly basis, the handling of issues | |
151 | and pull requested relative to that branch. When time permits, this may be done | |
152 | during the regularly scheduled FRR meeting. | |
153 | ||
154 | - ensure the stability of the branch, by using and eventually adapting the | |
155 | checking the CI tools of FRR ( indeed, maintaining may lead to create | |
156 | maintenance branches for topotests or for CI). | |
157 | ||
158 | It will not be possible to backport feature requests to LTS branches. Actually, it | |
159 | is a false good idea to use LTS for that need. Introducing feature requests may | |
160 | break the paradigm where all more recent releases should also include the feature | |
161 | request. This would require the LTS maintainer to ensure that all more recent | |
162 | releases have support for this feature request. Moreover, introducing features | |
163 | requests may result in breaking the stability of the branch. LTS branches are first | |
164 | done to bring long term support for stability. | |
8ce7861f | 165 | |
d1890d04 | 166 | Changelog |
b6820993 | 167 | --------- |
b22ba015 QY |
168 | The changelog will be the base for the release notes. A changelog entry for |
169 | your changes is usually not required and will be added based on your commit | |
170 | messages by the maintainers. However, you are free to include an update to the | |
171 | changelog with some better description. | |
d1890d04 QY |
172 | |
173 | Submitting Patches and Enhancements | |
9de103f0 | 174 | =================================== |
d1890d04 | 175 | |
b22ba015 QY |
176 | FRR accepts patches from two sources: |
177 | ||
178 | - Email (git format-patch) | |
b6820993 | 179 | - GitHub pull request |
b22ba015 | 180 | |
b6820993 QY |
181 | Contributors are highly encouraged to use GitHub's fork-and-PR workflow. It is |
182 | easier for us to review it, test it, try it and discuss it on GitHub than it is | |
183 | via email, thus your patch will get more attention more quickly on GitHub. | |
b22ba015 QY |
184 | |
185 | The base branch for new contributions and non-critical bug fixes should be | |
186 | ``master``. Please ensure your pull request is based on this branch when you | |
187 | submit it. | |
188 | ||
b6820993 QY |
189 | GitHub Pull Requests |
190 | -------------------- | |
d1890d04 | 191 | |
b6820993 QY |
192 | The preferred method of submitting changes is a GitHub pull request. Code |
193 | submitted by pull request will be automatically tested by one or more CI | |
194 | systems. Once the automated tests succeed, other developers will review your | |
195 | code for quality and correctness. After any concerns are resolved, your code | |
196 | will be merged into the branch it was submitted against. | |
d1890d04 | 197 | |
01bf2ccb LB |
198 | The title of the pull request should provide a high level technical |
199 | summary of the included patches. The description should provide | |
200 | additional details that will help the reviewer to understand the context | |
201 | of the included patches. | |
202 | ||
b6820993 QY |
203 | Patch Submission via Mailing List |
204 | --------------------------------- | |
d1890d04 | 205 | |
b6820993 QY |
206 | As an alternative submission method, a patch can be mailed to the |
207 | development mailing list. Patches received on the mailing list will be | |
208 | picked up by Patchwork and tested against the latest development branch. | |
d1890d04 | 209 | |
b6820993 QY |
210 | The recommended way to send the patch (or series of NN patches) to the |
211 | list is by using ``git send-email`` as follows (assuming they are the N | |
212 | most recent commit(s) in your git history):: | |
d1890d04 | 213 | |
b6820993 | 214 | git send-email -NN --annotate --to=dev@lists.frrouting.org |
d1890d04 | 215 | |
b6820993 QY |
216 | If your commits do not already contain a ``Signed-off-by`` line, then |
217 | use the following command to add it (after making sure you agree to the | |
218 | Developer Certificate of Origin as outlined above):: | |
d1890d04 | 219 | |
b6820993 | 220 | git send-email -NN --annotate --signoff --to=dev@lists.frrouting.org |
d1890d04 | 221 | |
b6820993 QY |
222 | Submitting multi-commit patches as a GitHub pull request is **strongly |
223 | encouraged** and increases the probability of your patch getting reviewed and | |
224 | merged in a timely manner. | |
d1890d04 | 225 | |
b6820993 | 226 | .. _license-for-contributions: |
d1890d04 | 227 | |
b6820993 QY |
228 | License for Contributions |
229 | ------------------------- | |
230 | FRR is under a “GPLv2 or later” license. Any code submitted must be released | |
231 | under the same license (preferred) or any license which allows redistribution | |
232 | under this GPLv2 license (eg MIT License). | |
e2abcff8 PG |
233 | It is forbidden to push any code that prevents from using GPLv3 license. This |
234 | becomes a community rule, as FRR produces binaries that links with Apache 2.0 | |
235 | libraries. Apache 2.0 and GPLv2 license are incompatible, if put together. | |
236 | Please see `<http://www.apache.org/licenses/GPL-compatibility.html>`_ for | |
237 | more information. This rule guarantees the user to distribute FRR binary code | |
238 | without any licensing issues. | |
b22ba015 | 239 | |
b6820993 QY |
240 | Pre-submission Checklist |
241 | ------------------------ | |
242 | - Format code (see `Code Formatting <#code-formatting>`__) | |
243 | - Verify and acknowledge license (see :ref:`license-for-contributions`) | |
244 | - Ensure you have properly signed off (see :ref:`signing-off`) | |
245 | - Test building with various configurations: | |
d1890d04 | 246 | |
b6820993 | 247 | - ``buildtest.sh`` |
d1890d04 | 248 | |
b6820993 | 249 | - Verify building source distribution: |
d1890d04 | 250 | |
b6820993 | 251 | - ``make dist`` (and try rebuilding from the resulting tar file) |
d1890d04 | 252 | |
b6820993 | 253 | - Run unit tests: |
d1890d04 | 254 | |
b6820993 | 255 | - ``make test`` |
d1890d04 | 256 | |
b6820993 QY |
257 | - In the case of a major new feature or other significant change, document |
258 | plans for continued maintenance of the feature | |
d1890d04 | 259 | |
b6820993 | 260 | .. _signing-off: |
d1890d04 | 261 | |
b6820993 QY |
262 | Signing Off |
263 | ----------- | |
264 | Code submitted to FRR must be signed off. We have the same requirements for | |
265 | using the signed-off-by process as the Linux kernel. In short, you must include | |
266 | a ``Signed-off-by`` tag in every patch. | |
d1890d04 | 267 | |
b6820993 QY |
268 | ``Signed-off-by`` is a developer's certification that they have the right to |
269 | submit the patch for inclusion into the project. It is an agreement to the | |
270 | :ref:`Developer's Certificate of Origin <developers-certificate-of-origin>`. | |
271 | Code without a proper ``Signed-off-by`` line cannot and will not be merged. | |
d1890d04 | 272 | |
b6820993 QY |
273 | If you are unfamiliar with this process, you should read the |
274 | `official policy at kernel.org <https://www.kernel.org/doc/html/latest/process/submitting-patches.html>`_. | |
275 | You might also find | |
276 | `this article <http://www.linuxfoundation.org/content/how-participate-linux-community-0>`_ | |
277 | about participating in the Linux community on the Linux Foundation website to | |
278 | be a helpful resource. | |
d1890d04 | 279 | |
b6820993 | 280 | .. _developers-certificate-of-origin: |
d1890d04 | 281 | |
b6820993 QY |
282 | In short, when you sign off on a commit, you assert your agreement to all of |
283 | the following:: | |
d1890d04 | 284 | |
b6820993 | 285 | Developer's Certificate of Origin 1.1 |
d1890d04 | 286 | |
b6820993 | 287 | By making a contribution to this project, I certify that: |
d1890d04 | 288 | |
b6820993 QY |
289 | (a) The contribution was created in whole or in part by me and I |
290 | have the right to submit it under the open source license | |
291 | indicated in the file; or | |
d1890d04 | 292 | |
b6820993 QY |
293 | (b) The contribution is based upon previous work that, to the best |
294 | of my knowledge, is covered under an appropriate open source | |
295 | license and I have the right under that license to submit that | |
296 | work with modifications, whether created in whole or in part by | |
297 | me, under the same open source license (unless I am permitted to | |
298 | submit under a different license), as indicated in the file; or | |
d1890d04 | 299 | |
b6820993 QY |
300 | (c) The contribution was provided directly to me by some other |
301 | person who certified (a), (b) or (c) and I have not modified it. | |
d1890d04 | 302 | |
b6820993 QY |
303 | (d) I understand and agree that this project and the contribution |
304 | are public and that a record of the contribution (including all | |
305 | personal information I submit with it, including my sign-off) is | |
306 | maintained indefinitely and may be redistributed consistent with | |
307 | this project or the open source license(s) involved. | |
d1890d04 | 308 | |
b6820993 | 309 | After Submitting Your Changes |
d1890d04 QY |
310 | ----------------------------- |
311 | ||
b6820993 | 312 | - Watch for Continuous Integration (CI) test results |
d1890d04 QY |
313 | |
314 | - You should automatically receive an email with the test results | |
315 | within less than 2 hrs of the submission. If you don’t get the | |
b6820993 | 316 | email, then check status on the GitHub pull request. |
d1890d04 | 317 | - Please notify the development mailing list if you think something |
b22ba015 | 318 | doesn't work. |
d1890d04 QY |
319 | |
320 | - If the tests failed: | |
321 | ||
322 | - In general, expect the community to ignore the submission until | |
323 | the tests pass. | |
324 | - It is up to you to fix and resubmit. | |
325 | ||
326 | - This includes fixing existing unit (“make test”) tests if your | |
327 | changes broke or changed them. | |
328 | - It also includes fixing distribution packages for the failing | |
329 | platforms (ie if new libraries are required). | |
330 | - Feel free to ask for help on the development list. | |
331 | ||
332 | - Go back to the submission process and repeat until the tests pass. | |
333 | ||
334 | - If the tests pass: | |
335 | ||
336 | - Wait for reviewers. Someone will review your code or be assigned | |
337 | to review your code. | |
493e3eed LB |
338 | - Respond to any comments or concerns the reviewer has. Use e-mail or |
339 | add a comment via github to respond or to let the reviewer know how | |
340 | their comment or concern is addressed. | |
341 | - An author must never delete or manually dismiss someone else's comments | |
342 | or review. (A review may be overridden by agreement in the weekly | |
343 | technical meeting.) | |
344 | - Automatically generated comments, e.g., those generated by CI systems, | |
345 | may be deleted by authors and others when such comments are not the most | |
22265b35 | 346 | recent results from that automated comment source. |
d1890d04 QY |
347 | - After all comments and concerns are addressed, expect your patch |
348 | to be merged. | |
349 | ||
350 | - Watch out for questions on the mailing list. At this time there will | |
351 | be a manual code review and further (longer) tests by various | |
352 | community members. | |
353 | - Your submission is done once it is merged to the master branch. | |
354 | ||
9de103f0 QY |
355 | Programming Languages, Tools and Libraries |
356 | ========================================== | |
357 | ||
358 | The core of FRR is written in C (gcc or clang supported) and makes | |
359 | use of GNU compiler extensions. A few non-essential scripts are | |
360 | implemented in Perl and Python. FRR requires the following tools | |
361 | to build distribution packages: automake, autoconf, texinfo, libtool and | |
362 | gawk and various libraries (i.e. libpam and libjson-c). | |
363 | ||
364 | If your contribution requires a new library or other tool, then please | |
365 | highlight this in your description of the change. Also make sure it’s | |
366 | supported by all FRR platform OSes or provide a way to build | |
367 | without the library (potentially without the new feature) on the other | |
368 | platforms. | |
369 | ||
370 | Documentation should be written in reStructuredText. Sphinx extensions may be | |
371 | utilized but pure ReST is preferred where possible. See | |
372 | :ref:`documentation`. | |
373 | ||
ca9dfee0 DL |
374 | Use of C++ |
375 | ---------- | |
376 | ||
377 | While C++ is not accepted for core components of FRR, extensions, modules or | |
378 | other distinct components may want to use C++ and include FRR header files. | |
379 | There is no requirement on contributors to work to retain C++ compatibility, | |
380 | but fixes for C++ compatibility are welcome. | |
381 | ||
382 | This implies that the burden of work to keep C++ compatibility is placed with | |
383 | the people who need it, and they may provide it at their leisure to the extent | |
384 | it is useful to them. So, if only a subset of header files, or even parts of | |
385 | a header file are made available to C++, this is perfectly fine. | |
386 | ||
590a7368 QY |
387 | Code Reviews |
388 | ============ | |
389 | ||
390 | Code quality is paramount for any large program. Consequently we require | |
391 | reviews of all submitted patches by at least one person other than the | |
392 | submitter before the patch is merged. | |
393 | ||
394 | Because of the nature of the software, FRR's maintainer list (i.e. those with | |
395 | commit permissions) tends to contain employees / members of various | |
396 | organizations. In order to prevent conflicts of interest, we use an honor | |
397 | system in which submissions from an individual representing one company should | |
398 | be merged by someone unaffiliated with that company. | |
399 | ||
400 | Guidelines for code review | |
924947e4 | 401 | -------------------------- |
590a7368 QY |
402 | |
403 | - As a rule of thumb, the depth of the review should be proportional to the | |
404 | scope and / or impact of the patch. | |
405 | ||
406 | - Anyone may review a patch. | |
407 | ||
408 | - When using GitHub reviews, marking "Approve" on a code review indicates | |
409 | willingness to merge the PR. | |
410 | ||
411 | - For individuals with merge rights, marking "Changes requested" is equivalent | |
412 | to a NAK. | |
413 | ||
414 | - For a PR you marked with "Changes requested", please respond to updates in a | |
415 | timely manner to avoid impeding the flow of development. | |
416 | ||
7e678379 LB |
417 | - Rejected or obsolete PRs are generally closed by the submitter based |
418 | on requests and/or agreement captured in a PR comment. The comment | |
419 | may originate with a reviewer or document agreement reached on Slack, | |
420 | the Development mailing list, or the weekly technical meeting. | |
421 | ||
590a7368 | 422 | |
b22ba015 | 423 | Coding Practices & Style |
9de103f0 | 424 | ======================== |
d1890d04 QY |
425 | |
426 | Commit messages | |
9de103f0 | 427 | --------------- |
d1890d04 QY |
428 | |
429 | Commit messages should be formatted in the same way as Linux kernel | |
b6820993 | 430 | commit messages. The format is roughly:: |
d1890d04 QY |
431 | |
432 | dir: short summary | |
433 | ||
434 | extended summary | |
435 | ||
b6820993 QY |
436 | ``dir`` should be the top level source directory under which the change was |
437 | made. For example, a change in :file:`bgpd/rfapi` would be formatted as:: | |
d1890d04 | 438 | |
9de103f0 | 439 | bgpd: short summary |
d1890d04 | 440 | |
b6820993 QY |
441 | ... |
442 | ||
443 | The first line should be no longer than 50 characters. Subsequent lines should | |
444 | be wrapped to 72 characters. | |
d1890d04 | 445 | |
b6820993 QY |
446 | You must also sign off on your commit. |
447 | ||
448 | .. seealso:: :ref:`signing-off` | |
449 | ||
450 | Source File Header | |
9de103f0 | 451 | ------------------ |
d1890d04 | 452 | |
b6820993 QY |
453 | New files must have a copyright header (see :ref:`license-for-contributions` |
454 | above) added to the file. The header should be: | |
d1890d04 | 455 | |
b6820993 | 456 | .. code-block:: c |
d1890d04 QY |
457 | |
458 | /* | |
459 | * Title/Function of file | |
460 | * Copyright (C) YEAR Author’s Name | |
461 | * | |
462 | * This program is free software; you can redistribute it and/or modify it | |
463 | * under the terms of the GNU General Public License as published by the Free | |
464 | * Software Foundation; either version 2 of the License, or (at your option) | |
465 | * any later version. | |
466 | * | |
467 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
468 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
469 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
470 | * more details. | |
471 | * | |
472 | * You should have received a copy of the GNU General Public License along | |
473 | * with this program; see the file COPYING; if not, write to the Free Software | |
474 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
475 | */ | |
476 | ||
477 | #include <zebra.h> | |
478 | ||
b6820993 QY |
479 | Please copy-paste this header verbatim. In particular: |
480 | ||
481 | - Do not replace "This program" with "FRR" | |
482 | - Do not change the address of the FSF | |
483 | ||
484 | Adding Copyright Claims to Existing Files | |
9de103f0 | 485 | ----------------------------------------- |
d1890d04 | 486 | |
b6820993 QY |
487 | When adding copyright claims for modifications to an existing file, please |
488 | add a ``Portions:`` section as shown below. If this section already exists, add | |
489 | your new claim at the end of the list. | |
d1890d04 | 490 | |
b6820993 | 491 | .. code-block:: c |
d1890d04 | 492 | |
b6820993 QY |
493 | /* |
494 | * Title/Function of file | |
495 | * Copyright (C) YEAR Author’s Name | |
496 | * Portions: | |
497 | * Copyright (C) 2010 Entity A .... | |
498 | * Copyright (C) 2016 Your name [optional brief change description] | |
499 | * ... | |
500 | */ | |
d1890d04 | 501 | |
c964e511 | 502 | Code Formatting |
9de103f0 | 503 | --------------- |
d1890d04 | 504 | |
6f7a9254 QY |
505 | C Code |
506 | ^^^^^^ | |
507 | ||
508 | For C code, FRR uses Linux kernel style except where noted below. Code which | |
509 | does not comply with these style guidelines will not be accepted. | |
d1890d04 | 510 | |
281ba953 QY |
511 | The project provides multiple tools to allow you to correctly style your code |
512 | as painlessly as possible, primarily built around ``clang-format``. | |
513 | ||
514 | clang-format | |
515 | In the project root there is a :file:`.clang-format` configuration file | |
516 | which can be used with the ``clang-format`` source formatter tool from the | |
517 | LLVM project. Most of the time, this is the easiest and smartest tool to | |
518 | use. It can be run in a variety of ways. If you point it at a C source file | |
519 | or directory of source files, it will format all of them. In the LLVM source | |
520 | tree there are scripts that allow you to integrate it with ``git``, ``vim`` | |
521 | and ``emacs``, and there are third-party plugins for other editors. The | |
522 | ``git`` integration is particularly useful; suppose you have some changes in | |
523 | your git index. Then, with the integration installed, you can do the | |
524 | following: | |
525 | ||
526 | :: | |
527 | ||
528 | git clang-format | |
529 | ||
530 | This will format *only* the changes present in your index. If you have just | |
531 | made a few commits and would like to correctly style only the changes made | |
532 | in those commits, you can use the following syntax: | |
533 | ||
534 | :: | |
535 | ||
536 | git clang-format HEAD~X | |
537 | ||
538 | Where X is one more than the number of commits back from the tip of your | |
539 | branch you would like ``clang-format`` to look at (similar to specifying the | |
540 | target for a rebase). | |
541 | ||
542 | The ``vim`` plugin is particularly useful. It allows you to select lines in | |
543 | visual line mode and press a key binding to invoke ``clang-format`` on only | |
544 | those lines. | |
545 | ||
546 | When using ``clang-format``, it is recommended to use the latest version. | |
547 | Each consecutive version generally has better handling of various edge | |
548 | cases. You may notice on occasion that two consecutive runs of | |
549 | ``clang-format`` over the same code may result in changes being made on the | |
550 | second run. This is an unfortunate artifact of the tool. Please check with | |
551 | the kernel style guide if in doubt. | |
552 | ||
553 | One stylistic problem with the FRR codebase is the use of ``DEFUN`` macros | |
554 | for defining CLI commands. ``clang-format`` will happily format these macro | |
555 | invocations, but the result is often unsightly and difficult to read. | |
556 | Consequently, FRR takes a more relaxed position with how these are | |
557 | formatted. In general you should lean towards using the style exemplified in | |
558 | the section on :ref:`command-line-interface`. Because ``clang-format`` | |
559 | mangles this style, there is a Python script named ``tools/indent.py`` that | |
560 | wraps ``clang-format`` and handles ``DEFUN`` macros as well as some other | |
561 | edge cases specific to FRR. If you are submitting a new file, it is | |
562 | recommended to run that script over the new file, preferably after ensuring | |
563 | that the latest stable release of ``clang-format`` is in your ``PATH``. | |
564 | ||
565 | Documentation on ``clang-format`` and its various integrations is maintained | |
566 | on the LLVM website. | |
567 | ||
568 | https://clang.llvm.org/docs/ClangFormat.html | |
569 | ||
570 | checkpatch.sh | |
571 | In the Linux kernel source tree there is a Perl script used to check | |
572 | incoming patches for style errors. FRR uses an adapted version of this | |
573 | script for the same purpose. It can be found at | |
2780ae0c | 574 | :file:`tools/checkpatch.sh`. This script takes a git-formatted diff or |
281ba953 QY |
575 | patch file, applies it to a clean FRR tree, and inspects the result to catch |
576 | potential style errors. Running this script on your patches before | |
577 | submission is highly recommended. The CI system runs this script as well and | |
578 | will comment on the PR with the results if style errors are found. | |
579 | ||
b6820993 | 580 | It is run like this:: |
281ba953 | 581 | |
b6820993 | 582 | ./checkpatch.sh <patch> <tree> |
281ba953 QY |
583 | |
584 | Reports are generated on ``stderr`` and the exit code indicates whether | |
585 | issues were found (2, 1) or not (0). | |
586 | ||
587 | Where ``<patch>`` is the path to the diff or patch file and ``<tree>`` is | |
588 | the path to your FRR source tree. The tree should be on the branch that you | |
589 | intend to submit the patch against. The script will make a best-effort | |
590 | attempt to save the state of your working tree and index before applying the | |
591 | patch, and to restore it when it is done, but it is still recommended that | |
592 | you have a clean working tree as the script does perform a hard reset on | |
593 | your tree during its run. | |
594 | ||
595 | The script reports two classes of issues, namely WARNINGs and ERRORs. Please | |
596 | pay attention to both of them. The script will generally report WARNINGs | |
597 | where it cannot be 100% sure that a particular issue is real. In most cases | |
598 | WARNINGs indicate an issue that needs to be fixed. Sometimes the script will | |
599 | report false positives; these will be handled in code review on a | |
600 | case-by-case basis. Since the script only looks at changed lines, | |
601 | occasionally changing one part of a line can cause the script to report a | |
602 | style issue already present on that line that is unrelated to the change. | |
603 | When convenient it is preferred that these be cleaned up inline, but this is | |
604 | not required. | |
605 | ||
115e70a1 PZ |
606 | In general, a developer should heed the information reported by checkpatch. |
607 | However, some flexibility is needed for cases where human judgement yields | |
608 | better clarity than the script. Accordingly, it may be appropriate to | |
609 | ignore some checkpatch.sh warnings per discussion among the submitter(s) | |
610 | and reviewer(s) of a change. Misreporting of errors by the script is | |
d3c2e316 QY |
611 | possible. When this occurs, the exception should be handled either by |
612 | patching checkpatch to correct the false error report, or by documenting the | |
613 | exception in this document under :ref:`style-exceptions`. If the incorrect | |
614 | report is likely to appear again, a checkpatch update is preferred. | |
115e70a1 | 615 | |
281ba953 QY |
616 | If the script finds one or more WARNINGs it will exit with 1. If it finds |
617 | one or more ERRORs it will exit with 2. | |
618 | ||
619 | ||
620 | Please remember that while FRR provides these tools for your convenience, | |
621 | responsibility for properly formatting your code ultimately lies on the | |
622 | shoulders of the submitter. As such, it is recommended to double-check the | |
623 | results of these tools to avoid delays in merging your submission. | |
d1890d04 | 624 | |
115e70a1 PZ |
625 | In some cases, these tools modify or flag the format in ways that go beyond or |
626 | even conflict [#tool_style_conflicts]_ with the canonical documented Linux | |
627 | kernel style. In these cases, the Linux kernel style takes priority; | |
628 | non-canonical issues flagged by the tools are not compulsory but rather are | |
629 | opportunities for discussion among the submitter(s) and reviewer(s) of a change. | |
630 | ||
d1890d04 QY |
631 | **Whitespace changes in untouched parts of the code are not acceptable |
632 | in patches that change actual code.** To change/fix formatting issues, | |
633 | please create a separate patch that only does formatting changes and | |
634 | nothing else. | |
635 | ||
d1890d04 QY |
636 | Kernel and BSD styles are documented externally: |
637 | ||
638 | - https://www.kernel.org/doc/html/latest/process/coding-style.html | |
639 | - http://man.openbsd.org/style | |
640 | ||
641 | For GNU coding style, use ``indent`` with the following invocation: | |
642 | ||
643 | :: | |
644 | ||
645 | indent -nut -nfc1 file_for_submission.c | |
646 | ||
28ac5a03 QY |
647 | |
648 | Historically, FRR used fixed-width integral types that do not exist in any | |
649 | standard but were defined by most platforms at some point. Officially these | |
650 | types are not guaranteed to exist. Therefore, please use the fixed-width | |
651 | integral types introduced in the C99 standard when contributing new code to | |
652 | FRR. If you need to convert a large amount of code to use the correct types, | |
653 | there is a shell script in :file:`tools/convert-fixedwidth.sh` that will do the | |
654 | necessary replacements. | |
655 | ||
656 | +-----------+--------------------------+ | |
657 | | Incorrect | Correct | | |
658 | +===========+==========================+ | |
659 | | u_int8_t | uint8_t | | |
660 | +-----------+--------------------------+ | |
661 | | u_int16_t | uint16_t | | |
662 | +-----------+--------------------------+ | |
663 | | u_int32_t | uint32_t | | |
664 | +-----------+--------------------------+ | |
665 | | u_int64_t | uint64_t | | |
666 | +-----------+--------------------------+ | |
667 | | u_char | uint8_t or unsigned char | | |
668 | +-----------+--------------------------+ | |
669 | | u_short | unsigned short | | |
670 | +-----------+--------------------------+ | |
671 | | u_int | unsigned int | | |
672 | +-----------+--------------------------+ | |
673 | | u_long | unsigned long | | |
674 | +-----------+--------------------------+ | |
675 | ||
d3c2e316 QY |
676 | .. _style-exceptions: |
677 | ||
d1890d04 QY |
678 | Exceptions |
679 | ^^^^^^^^^^ | |
680 | ||
681 | FRR project code comes from a variety of sources, so there are some | |
682 | stylistic exceptions in place. They are organized here by branch. | |
683 | ||
9de103f0 QY |
684 | For ``master`` |
685 | """""""""""""" | |
d1890d04 QY |
686 | |
687 | BSD coding style applies to: | |
688 | ||
689 | - ``ldpd/`` | |
690 | ||
691 | ``babeld`` uses, approximately, the following style: | |
692 | ||
693 | - K&R style braces | |
694 | - Indents are 4 spaces | |
695 | - Function return types are on their own line | |
696 | ||
9de103f0 QY |
697 | For ``stable/3.0`` and ``stable/2.0`` |
698 | """"""""""""""""""""""""""""""""""""" | |
d1890d04 QY |
699 | |
700 | GNU coding style apply to the following parts: | |
701 | ||
702 | - ``lib/`` | |
703 | - ``zebra/`` | |
704 | - ``bgpd/`` | |
705 | - ``ospfd/`` | |
706 | - ``ospf6d/`` | |
707 | - ``isisd/`` | |
708 | - ``ripd/`` | |
709 | - ``ripngd/`` | |
710 | - ``vtysh/`` | |
711 | ||
712 | BSD coding style applies to: | |
713 | ||
714 | - ``ldpd/`` | |
715 | ||
6f7a9254 QY |
716 | YANG |
717 | ^^^^ | |
718 | ||
719 | FRR uses YANG to define data models for its northbound interface. YANG models | |
720 | should follow conventions used by the IETF standard models. From a practical | |
721 | standpoint, this corresponds to the output produced by the ``yanglint`` tool | |
722 | included in the ``libyang`` project, which is used by FRR to parse and validate | |
723 | YANG models. You should run the following command on all YANG documents you | |
724 | write: | |
725 | ||
726 | .. code-block:: console | |
727 | ||
728 | yanglint -f yang <model> | |
729 | ||
730 | The output of this command should be identical to the input file. The sole | |
731 | exception to this is comments. ``yanglint`` does not support comments and will | |
732 | strip them from its output. You may include comments in your YANG documents, | |
733 | but they should be indented appropriately (use spaces). Where possible, | |
734 | comments should be eschewed in favor of a suitable ``description`` statement. | |
735 | ||
736 | In short, a diff between your input file and the output of ``yanglint`` should | |
737 | either be empty or contain only comments. | |
d3c2e316 QY |
738 | |
739 | Specific Exceptions | |
740 | ^^^^^^^^^^^^^^^^^^^ | |
741 | ||
742 | Most of the time checkpatch errors should be corrected. Occasionally as a group | |
743 | maintainers will decide to ignore certain stylistic issues. Usually this is | |
744 | because correcting the issue is not possible without large unrelated code | |
745 | changes. When an exception is made, if it is unlikely to show up again and | |
746 | doesn't warrant an update to checkpatch, it is documented here. | |
747 | ||
748 | +------------------------------------------+---------------------------------------------------------------+ | |
749 | | Issue | Ignore Reason | | |
750 | +==========================================+===============================================================+ | |
751 | | DEFPY_HIDDEN, DEFPY_ATTR: complex macros | DEF* macros cannot be wrapped in parentheses without updating | | |
752 | | should be wrapped in parentheses | all usages of the macro, which would be highly disruptive. | | |
753 | +------------------------------------------+---------------------------------------------------------------+ | |
754 | ||
d1890d04 | 755 | Compile-time conditional code |
9de103f0 | 756 | ----------------------------- |
d1890d04 QY |
757 | |
758 | Many users access FRR via binary packages from 3rd party sources; | |
759 | compile-time code puts inclusion/exclusion in the hands of the package | |
760 | maintainer. Please think very carefully before making code conditional | |
761 | at compile time, as it increases regression testing, maintenance | |
762 | burdens, and user confusion. In particular, please avoid gratuitous | |
763 | ``--enable-…`` switches to the configure script - in general, code | |
764 | should be of high quality and in working condition, or it shouldn’t be | |
765 | in FRR at all. | |
766 | ||
767 | When code must be compile-time conditional, try have the compiler make | |
768 | it conditional rather than the C pre-processor so that it will still be | |
769 | checked by the compiler, even if disabled. For example, | |
770 | ||
771 | :: | |
772 | ||
773 | if (SOME_SYMBOL) | |
774 | frobnicate(); | |
775 | ||
776 | is preferred to | |
777 | ||
778 | :: | |
779 | ||
780 | #ifdef SOME_SYMBOL | |
781 | frobnicate (); | |
782 | #endif /* SOME_SYMBOL */ | |
783 | ||
b6820993 QY |
784 | Note that the former approach requires ensuring that ``SOME_SYMBOL`` will be |
785 | defined (watch your ``AC_DEFINE``\ s). | |
d1890d04 QY |
786 | |
787 | Debug-guards in code | |
9de103f0 | 788 | -------------------- |
d1890d04 | 789 | |
b6820993 QY |
790 | Debugging statements are an important methodology to allow developers to fix |
791 | issues found in the code after it has been released. The caveat here is that | |
792 | the developer must remember that people will be using the code at scale and in | |
793 | ways that can be unexpected for the original implementor. As such debugs | |
794 | **MUST** be guarded in such a way that they can be turned off. FRR has the | |
795 | ability to turn on/off debugs from the CLI and it is expected that the | |
796 | developer will use this convention to allow control of their debugs. | |
d1890d04 | 797 | |
81047bc5 DL |
798 | Custom syntax-like block macros |
799 | ------------------------------- | |
800 | ||
801 | FRR uses some macros that behave like the ``for`` or ``if`` C keywords. These | |
802 | macros follow these patterns: | |
803 | ||
804 | - loop-style macros are named ``frr_each_*`` (and ``frr_each``) | |
805 | - single run macros are named ``frr_with_*`` | |
806 | - to avoid confusion, ``frr_with_*`` macros must always use a ``{ ... }`` | |
807 | block even if the block only contains one statement. The ``frr_each`` | |
808 | constructs are assumed to be well-known enough to use normal ``for`` rules. | |
809 | - ``break``, ``return`` and ``goto`` all work correctly. For loop-style | |
810 | macros, ``continue`` works correctly too. | |
811 | ||
812 | Both the ``each`` and ``with`` keywords are inspired by other (more | |
813 | higher-level) programming languages that provide these constructs. | |
814 | ||
815 | There are also some older iteration macros, e.g. ``ALL_LIST_ELEMENTS`` and | |
816 | ``FOREACH_AFI_SAFI``. These macros in some cases do **not** fulfill the above | |
817 | pattern (e.g. ``break`` does not work in ``FOREACH_AFI_SAFI`` because it | |
818 | expands to 2 nested loops.) | |
819 | ||
9e001286 QY |
820 | Static Analysis and Sanitizers |
821 | ------------------------------ | |
81af0317 DL |
822 | Clang/LLVM and GCC come with a variety of tools that can be used to help find |
823 | bugs in FRR. | |
9e001286 QY |
824 | |
825 | clang-analyze | |
826 | This is a static analyzer that scans the source code looking for patterns | |
827 | that are likely to be bugs. The tool is run automatically on pull requests | |
828 | as part of CI and new static analysis warnings will be placed in the CI | |
829 | results. FRR aims for absolutely zero static analysis errors. While the | |
830 | project is not quite there, code that introduces new static analysis errors | |
831 | is very unlikely to be merged. | |
832 | ||
833 | AddressSanitizer | |
834 | This is an excellent tool that provides runtime instrumentation for | |
835 | detecting memory errors. As part of CI FRR is built with this | |
836 | instrumentation and run through a series of tests to look for any results. | |
837 | Testing your own code with this tool before submission is encouraged. You | |
838 | can enable it by passing:: | |
d5403d4f | 839 | |
9e001286 QY |
840 | --enable-address-sanitizer |
841 | ||
842 | to ``configure``. | |
843 | ||
844 | ThreadSanitizer | |
845 | Similar to AddressSanitizer, this tool provides runtime instrumentation for | |
846 | detecting data races. If you are working on or around multithreaded code, | |
847 | extensive testing with this instrumtation enabled is *highly* recommended. | |
848 | You can enable it by passing:: | |
d5403d4f | 849 | |
9e001286 QY |
850 | --enable-thread-sanitizer |
851 | ||
852 | to ``configure``. | |
853 | ||
854 | MemorySanitizer | |
855 | Similar to AddressSanitizer, this tool provides runtime instrumentation for | |
856 | detecting use of uninitialized heap memory. Testing your own code with this | |
857 | tool before submission is encouraged. You can enable it by passing:: | |
d5403d4f | 858 | |
9e001286 QY |
859 | --enable-memory-sanitizer |
860 | ||
861 | to ``configure``. | |
862 | ||
863 | All of the above tools are available in the Clang/LLVM toolchain since 3.4. | |
864 | AddressSanitizer and ThreadSanitizer are available in recent versions of GCC, | |
865 | but are no longer actively maintained. MemorySanitizer is not available in GCC. | |
866 | ||
81af0317 DL |
867 | .. note:: |
868 | ||
869 | The different Sanitizers are mostly incompatible with each other. Please | |
870 | refer to GCC/LLVM documentation for details. | |
871 | ||
9e001286 QY |
872 | Additionally, the FRR codebase is regularly scanned with Coverity. |
873 | Unfortunately Coverity does not have the ability to handle scanning pull | |
874 | requests, but after code is merged it will send an email notifying project | |
875 | members with Coverity access of newly introduced defects. | |
876 | ||
81af0317 DL |
877 | Executing non-installed dynamic binaries |
878 | ---------------------------------------- | |
879 | ||
880 | Since FRR uses the GNU autotools build system, it inherits its shortcomings. | |
881 | To execute a binary directly from the build tree under a wrapper like | |
882 | `valgrind`, `gdb` or `strace`, use:: | |
883 | ||
884 | ./libtool --mode=execute valgrind [--valgrind-opts] zebra/zebra [--zebra-opts] | |
885 | ||
886 | While replacing valgrind/zebra as needed. The `libtool` script is found in | |
887 | the root of the build directory after `./configure` has completed. Its purpose | |
888 | is to correctly set up `LD_LIBRARY_PATH` so that libraries from the build tree | |
889 | are used. (On some systems, `libtool` is also available from PATH, but this is | |
890 | not always the case.) | |
891 | ||
d1890d04 | 892 | CLI changes |
9de103f0 | 893 | ----------- |
d1890d04 | 894 | |
b6820993 QY |
895 | CLI's are a complicated ugly beast. Additions or changes to the CLI should use |
896 | a DEFUN to encapsulate one setting as much as is possible. Additionally as new | |
897 | DEFUN's are added to the system, documentation should be provided for the new | |
898 | commands. | |
d1890d04 QY |
899 | |
900 | Backwards Compatibility | |
9de103f0 | 901 | ----------------------- |
d1890d04 | 902 | |
b6820993 QY |
903 | As a general principle, changes to CLI and code in the lib/ directory should be |
904 | made in a backwards compatible fashion. This means that changes that are purely | |
905 | stylistic in nature should be avoided, e.g., renaming an existing macro or | |
906 | library function name without any functional change. When adding new parameters | |
907 | to common functions, it is also good to consider if this too should be done in | |
908 | a backward compatible fashion, e.g., by preserving the old form in addition to | |
d1890d04 QY |
909 | adding the new form. |
910 | ||
b6820993 QY |
911 | This is not to say that minor or even major functional changes to CLI and |
912 | common code should be avoided, but rather that the benefit gained from a change | |
913 | should be weighed against the added cost/complexity to existing code. Also, | |
914 | that when making such changes, it is good to preserve compatibility when | |
915 | possible to do so without introducing maintenance overhead/cost. It is also | |
916 | important to keep in mind, existing code includes code that may reside in | |
917 | private repositories (and is yet to be submitted) or code that has yet to be | |
918 | migrated from Quagga to FRR. | |
110bb121 | 919 | |
b6820993 QY |
920 | That said, compatibility measures can (and should) be removed when either: |
921 | ||
922 | - they become a significant burden, e.g. when data structures change and the | |
923 | compatibility measure would need a complex adaptation layer or becomes | |
924 | flat-out impossible | |
925 | - some measure of time (dependent on the specific case) has passed, so that | |
926 | the compatibility grace period is considered expired. | |
927 | ||
e12ea4bb QY |
928 | For CLI commands, the deprecation period is 1 year. |
929 | ||
b6820993 QY |
930 | In all cases, compatibility pieces should be marked with compiler/preprocessor |
931 | annotations to print warnings at compile time, pointing to the appropriate | |
932 | update path. A ``-Werror`` build should fail if compatibility bits are used. To | |
933 | avoid compilation issues in released code, such compiler/preprocessor | |
934 | annotations must be ignored non-development branches. For example: | |
935 | ||
936 | .. code-block:: c | |
937 | ||
e60dd6ca | 938 | #if CONFDATE > 20180403 |
b6820993 QY |
939 | CPP_NOTICE("Use of <XYZ> is deprecated, please use <ABC>") |
940 | #endif | |
d1890d04 | 941 | |
cab3f811 LB |
942 | Preferably, the shell script :file:`tools/fixup-deprecated.py` will be |
943 | updated along with making non-backwards compatible code changes, or an | |
944 | alternate script should be introduced, to update the code to match the | |
945 | change. When the script is updated, there is no need to preserve the | |
946 | deprecated code. Note that this does not apply to user interface | |
947 | changes, just internal code, macros and libraries. | |
948 | ||
d1890d04 | 949 | Miscellaneous |
9de103f0 | 950 | ------------- |
d1890d04 | 951 | |
b6820993 QY |
952 | When in doubt, follow the guidelines in the Linux kernel style guide, or ask on |
953 | the development mailing list / public Slack instance. | |
9de103f0 QY |
954 | |
955 | ||
956 | .. _documentation: | |
957 | ||
958 | Documentation | |
959 | ============= | |
960 | ||
961 | FRR uses Sphinx+RST as its documentation system. The document you are currently | |
962 | reading was generated by Sphinx from RST source in | |
963 | :file:`doc/developer/workflow.rst`. The documentation is structured as follows: | |
964 | ||
d5403d4f QY |
965 | +-----------------------+-------------------------------------------+ |
966 | | Directory | Contents | | |
967 | +=======================+===========================================+ | |
968 | | :file:`doc/user` | User documentation; configuration guides; | | |
969 | | | protocol overviews | | |
970 | +-----------------------+-------------------------------------------+ | |
971 | | :file:`doc/developer` | Developer's documentation; API specs; | | |
972 | | | datastructures; architecture overviews; | | |
973 | | | project management procedure | | |
974 | +-----------------------+-------------------------------------------+ | |
975 | | :file:`doc/manpages` | Source for manpages | | |
976 | +-----------------------+-------------------------------------------+ | |
977 | | :file:`doc/figures` | Images and diagrams | | |
978 | +-----------------------+-------------------------------------------+ | |
979 | | :file:`doc/extra` | Miscellaneous Sphinx extensions, scripts, | | |
980 | | | customizations, etc. | | |
981 | +-----------------------+-------------------------------------------+ | |
982 | ||
983 | Each of these directories, with the exception of :file:`doc/figures` and | |
984 | :file:`doc/extra`, contains a Sphinx-generated Makefile and configuration | |
985 | script :file:`conf.py` used to set various document parameters. The makefile | |
986 | can be used for a variety of targets; invoke `make help` in any of these | |
987 | directories for a listing of available output formats. For convenience, there | |
988 | is a top-level :file:`Makefile.am` that has targets for PDF and HTML | |
989 | documentation for both developer and user documentation, respectively. That | |
990 | makefile is also responsible for building manual pages packed with distribution | |
991 | builds. | |
9de103f0 QY |
992 | |
993 | Indent and styling should follow existing conventions: | |
994 | ||
995 | - 3 spaces for indents under directives | |
996 | - Cross references may contain only lowercase alphanumeric characters and | |
997 | hyphens ('-') | |
998 | - Lines wrapped to 80 characters where possible | |
999 | ||
1000 | Characters for header levels should follow Python documentation guide: | |
1001 | ||
1002 | - ``#`` with overline, for parts | |
1003 | - ``*`` with overline, for chapters | |
1004 | - ``=``, for sections | |
1005 | - ``-``, for subsections | |
1006 | - ``^``, for subsubsections | |
1007 | - ``"``, for paragraphs | |
1008 | ||
1009 | After you have made your changes, please make sure that you can invoke | |
1010 | ``make latexpdf`` and ``make html`` with no warnings. | |
1011 | ||
1012 | The documentation is currently incomplete and needs love. If you find a broken | |
1013 | cross-reference, figure, dead hyperlink, style issue or any other nastiness we | |
1014 | gladly accept documentation patches. | |
1015 | ||
c91e9b8f QY |
1016 | To build the docs, please ensure you have installed a recent version of |
1017 | `Sphinx <http://www.sphinx-doc.org/en/stable/install.html>`_. If you want to | |
1018 | build LaTeX or PDF docs, you will also need a full LaTeX distribution | |
1019 | installed. | |
1020 | ||
9de103f0 QY |
1021 | Code |
1022 | ---- | |
1023 | ||
1024 | FRR is a large and complex software project developed by many different people | |
1025 | over a long period of time. Without adequate documentation, it can be | |
1026 | exceedingly difficult to understand code segments, APIs and other interfaces. | |
1027 | In the interest of keeping the project healthy and maintainable, you should | |
1028 | make every effort to document your code so that other people can understand | |
1029 | what it does without needing to closely read the code itself. | |
1030 | ||
1031 | Some specific guidelines that contributors should follow are: | |
1032 | ||
1033 | - Functions exposed in header files should have descriptive comments above | |
1034 | their signatures in the header file. At a minimum, a function comment should | |
1035 | contain information about the return value, parameters, and a general summary | |
1036 | of the function's purpose. Documentation on parameter values can be omitted | |
1037 | if it is (very) obvious what they are used for. | |
1038 | ||
1039 | Function comments must follow the style for multiline comments laid out in | |
1040 | the kernel style guide. | |
1041 | ||
1042 | Example: | |
1043 | ||
1044 | .. code-block:: c | |
1045 | ||
1046 | /* | |
1047 | * Determines whether or not a string is cool. | |
1048 | * | |
b6820993 QY |
1049 | * text |
1050 | * the string to check for coolness | |
1051 | * | |
1052 | * is_clccfc | |
1053 | * whether capslock is cruise control for cool | |
1054 | * | |
1055 | * Returns: | |
1056 | * 7 if the text is cool, 0 otherwise | |
9de103f0 QY |
1057 | */ |
1058 | int check_coolness(const char *text, bool is_clccfc); | |
1059 | ||
b6820993 QY |
1060 | Function comments should make it clear what parameters and return values are |
1061 | used for. | |
9de103f0 QY |
1062 | |
1063 | - Static functions should have descriptive comments in the same form as above | |
1064 | if what they do is not immediately obvious. Use good engineering judgement | |
1065 | when deciding whether a comment is necessary. If you are unsure, document | |
1066 | your code. | |
1067 | - Global variables, static or not, should have a comment describing their use. | |
1068 | - **For new code in lib/, these guidelines are hard requirements.** | |
1069 | ||
1070 | If you make significant changes to portions of the codebase covered in the | |
1071 | Developer's Manual, add a major subsystem or feature, or gain arcane mastery of | |
1072 | some undocumented or poorly documented part of the codebase, please document | |
1073 | your work so others can benefit. If you add a major feature or introduce a new | |
1074 | API, please document the architecture and API to the best of your abilities in | |
1075 | the Developer's Manual, using good judgement when choosing where to place it. | |
1076 | ||
1077 | Finally, if you come across some code that is undocumented and feel like | |
1078 | going above and beyond, document it! We absolutely appreciate and accept | |
1079 | patches that document previously undocumented code. | |
1080 | ||
1081 | User | |
1082 | ---- | |
1083 | ||
1084 | If you are contributing code that adds significant user-visible functionality | |
1085 | please document how to use it in :file:`doc/user`. Use good judgement when | |
1086 | choosing where to place documentation. For example, instructions on how to use | |
1087 | your implementation of a new BGP draft should go in the BGP chapter instead of | |
1088 | being its own chapter. If you are adding a new protocol daemon, please create a | |
1089 | new chapter. | |
1090 | ||
d5403d4f QY |
1091 | FRR Specific Markup |
1092 | ------------------- | |
1093 | ||
1094 | FRR has some customizations applied to the Sphinx markup that go a long way | |
1095 | towards making documentation easier to use, write and maintain. | |
1096 | ||
1097 | CLI Commands | |
1098 | ^^^^^^^^^^^^ | |
1099 | ||
9de103f0 QY |
1100 | When documenting CLI please use a combination of the ``.. index::`` and |
1101 | ``.. clicmd::`` directives. For example, the command :clicmd:`show pony` would | |
1102 | be documented as follows: | |
1103 | ||
1104 | .. code-block:: rest | |
1105 | ||
1106 | .. index:: show pony | |
1107 | .. clicmd:: show pony | |
1108 | ||
1109 | Prints an ASCII pony. Example output::: | |
1110 | ||
1111 | >>\. | |
1112 | /_ )`. | |
1113 | / _)`^)`. _.---. _ | |
1114 | (_,' \ `^-)"" `.\ | |
1115 | | | \ | |
1116 | \ / | | |
1117 | / \ /.___.'\ (\ (_ | |
1118 | < ,"|| \ |`. \`-' | |
1119 | \\ () )| )/ | |
1120 | hjw |_>|> /_] // | |
1121 | /_] /_] | |
1122 | ||
1123 | When documented this way, CLI commands can be cross referenced with the | |
1124 | ``:clicmd:`` inline markup like so: | |
1125 | ||
1126 | .. code-block:: rest | |
1127 | ||
1128 | :clicmd:`show pony` | |
1129 | ||
1130 | This is very helpful for users who want to quickly remind themselves what a | |
1131 | particular command does. | |
1132 | ||
d5403d4f QY |
1133 | Configuration Snippets |
1134 | ^^^^^^^^^^^^^^^^^^^^^^ | |
1135 | ||
1136 | When putting blocks of example configuration please use the | |
1137 | ``.. code-block::`` directive and specify ``frr`` as the highlighting language, | |
1138 | as in the following example. This will tell Sphinx to use a custom Pygments | |
1139 | lexer to highlight FRR configuration syntax. | |
1140 | ||
1141 | .. code-block:: rest | |
1142 | ||
1143 | .. code-block:: frr | |
1144 | ||
1145 | ! | |
1146 | ! Example configuration file. | |
1147 | ! | |
1148 | log file /tmp/log.log | |
1149 | service integrated-vtysh-config | |
1150 | ! | |
1151 | ip route 1.2.3.0/24 reject | |
1152 | ipv6 route de:ea:db:ee:ff::/64 reject | |
1153 | ! | |
1154 | ||
1155 | ||
9de103f0 QY |
1156 | .. _GitHub: https://github.com/frrouting/frr |
1157 | .. _GitHub issues: https://github.com/frrouting/frr/issues | |
115e70a1 PZ |
1158 | |
1159 | .. rubric:: Footnotes | |
1160 | ||
1161 | .. [#tool_style_conflicts] For example, lines over 80 characters are allowed | |
1162 | for text strings to make it possible to search the code for them: please | |
1163 | see `Linux kernel style (breaking long lines and strings) <https://www.kernel.org/doc/html/v4.10/process/coding-style.html#breaking-long-lines-and-strings>`_ | |
1164 | and `Issue #1794 <https://github.com/FRRouting/frr/issues/1794>`_. |