Commit Graph

104 Commits

Author SHA1 Message Date
Quentin Young
e45651fbd0 doc: include checkpatch & cspf docs in toctree
The documentation pages on checkpatch and CSPF were not reachable
because they were not included in any toctree. Include them in the tree!

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-27 19:55:35 -04:00
Quentin Young
d2292c6bfe doc: fix whitespace, formatting errors
* Fix various whitespace and syntax errors
* Fix a couple tiny grammar mistakes

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-27 19:55:35 -04:00
Donatas Abraitis
fb5f11ae67 doc: Use backward order when for release dates hint
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-09-27 16:49:56 +03:00
Donatas Abraitis
21d718aa6c doc: Fix release dates in workflow
Align to the release rules:

Releases are scheduled in a 4-month cycle on the first Tuesday each March/July/November.

Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-09-27 16:45:01 +03:00
Donald Sharp
cdf6c5e587 doc: Prohibit usage of system() calls in FRR
See the documentation update, but system() calls and
it's ilk block the processing of SIGINT and they are
not properly handled as a result leading to shutdown
issues where one or more daemons never stop.

See aa530b627d as an example
of system call usage removed from the system.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-08-11 13:28:54 -04:00
Acee Lindem
f8831ce197 doc: Fix typo in previous Coverity workflow doc commit.
Signed-off-by: Acee Lindem <aceelindem@gmail.com>
2023-06-21 07:11:10 -04:00
Christian Hopps
786a1e95bc doc: add the linux doc for checkpatch.pl
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-06-20 01:05:30 -04:00
Acee Lindem
4d2fe4a4de doc: Update Coverity workflow in developer documentation.
Signed-off-by: Acee Lindem <aceelindem@gmail.com>
2023-06-13 16:10:48 -04:00
Donatas Abraitis
b28e2c59dc doc: Update reference table for current and upcoming release dates
Keep only 3 release dates, current and two upcoming. On the next release,
just update one, instead of multiple (zero point looking too much in the
future).

Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-05-31 23:17:27 +03:00
Christian Hopps
2ac74f0dbe doc: python, required by clippy, is no longer a non-essential tool
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-05-09 20:25:54 +00:00
Donatas Abraitis
ae7b16b2d4
Merge pull request #12960 from anlancs/doc/some-words-doc
doc: Correct some words
2023-03-07 08:25:50 +02:00
anlan_cs
c3e691229e doc: Correct some words
Note that `ASNUM` in table, it is missing right parenthesis for
`(1-4294967295)`. So, adjust this table.

And correct other words for doc.

Signed-off-by: anlan_cs <vic.lan@pica8.com>
2023-03-06 17:12:50 +08:00
Donatas Abraitis
70594ab7bd tools: Do not force Sentence-case for commit messages
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-03-03 14:10:36 +02:00
David Lamparter
0d60d63f94 doc: update workflow docs for SPDX header
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2023-02-09 14:09:11 +01:00
Donatas Abraitis
2be1c4002b doc: Define why my pull request was closed
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-01-31 13:29:24 +02:00
Donatas Abraitis
19b8d68cf8 doc: Add a documentation about commit conventions
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-01-31 13:25:27 +02:00
Donatas Abraitis
843427dd69 doc: Write a short introduction about squashing commits
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-01-31 10:59:01 +02:00
Christian Hopps
b44b66c7bf doc: add guidance for CLI cmds that output JSON
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-01-05 04:33:01 -05:00
David Lamparter
ad5fef3ded doc: introduce FRR community "accords"
The idea here is to pass "non-code agreements" through the PR review
mechanism, and have them visible in the git tree.

Two "example" (but real) accords are included, mostly to illustrate the
idea.  Both of these should be non-controversial and have had some
previous discussion in random places.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2022-12-08 12:06:37 +01:00
Donatas Abraitis
f4ebc6f04e doc: Do not forget to update the reference table for release dates
As a part of release, an additional checkpoint when creating a stabilization
branch.

Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2022-11-28 17:37:24 +02:00
Donatas Abraitis
9de44c0a1b doc: Update release dates and add a hint on how to get dates correctly
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2022-11-28 17:37:23 +02:00
Donatas Abraitis
bfb8639395 doc, tools: Update release dates in workflow.rst
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2022-05-27 08:25:12 +03:00
David Lamparter
3f115705d3 build: enable -fms-extensions
This eases incorporating fields from/"subclassing" another struct.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2022-04-04 18:33:10 +02:00
David Lamparter
5b4f4e626f build: first header *must* be zebra.h or config.h
This has already been a requirement for Solaris, it is still a
requirement for some of the autoconf feature checks to work correctly,
and it will be a requirement for `-fms-extensions`.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2022-04-04 18:33:10 +02:00
Donald Sharp
264274daed doc: List DEFUN as deprecated
New development should use DEFPY.  Document this

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2022-02-15 12:35:09 -05:00
Donald Sharp
e605a2391a doc: Update documentation to state new code must use latest approved methods
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2022-02-15 12:35:09 -05:00
Donatas Abraitis
0a3fa828f8 doc: An example how we do RC tagging for stabilization branch
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2022-02-13 21:23:53 +02:00
Donald Sharp
add70bc315 doc: Update workflow.rst for release management
Some release management updates

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2022-02-09 07:56:00 -05:00
Jafar Al-Gharaibeh
c1242b7be5 doc: the dev tag should come after the new version commit step
Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
2022-02-08 10:50:15 -06:00
Donatas Abraitis
5568f9d12b doc: Add a commands snippet to workflow about what to do in the 1st phase
What we should do when creating stabilization branch from the master.

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2022-02-05 10:07:32 +02:00
Igor Ryzhov
85c6eccad9 doc: cleanup submitting patches and enhancements
Remove some remains from the times when patches were accepted via email.

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2022-01-17 20:21:08 +03:00
Donald Sharp
c6c39c05b5
Merge pull request #9684 from opensourcerouting/printfrr-false-positive
*: `frr-format` with unmodified GCC
2021-10-14 07:34:20 -04:00
David Lamparter
16044e7ff7 doc/developer: document dev tag on master
We have `frr-X.Y-dev` tags on master after pulling stable branches,
otherwise the `gitversion` tooling / `--with-pkg-git-version` gets
_very_ confused (it'll print something like:

```
FRRouting 8.2-dev-g210a75e65dad (areia).
Copyright 1996-2005 Kunihiro Ishiguro, et al.
This is a git build of frr-8.1-rc1-8-g210a75e65dad
```

(Note the conflicting version numbers.)

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-10-06 18:15:23 +02:00
David Lamparter
f62de63c6a *: frr-format with unmodified GCC
Since there's very few locations where the `frr-format` actually prints
false positive warnings, consensus seems to be to just work around the
false positives even if the code is correct.

In fact, there is only one pattern of false positives currently, in
`bfdd/dplane.c` which does `vty_out("%"PRIu64, (uint64_t)be64toh(...))`.
The workaround/fix for this is a replacement `be64toh` whose type is
always `uint64_t` regardless of what OS we're on, making the cast
unnecessary.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-09-28 11:20:32 +02:00
David Lamparter
161ed8a690 doc/workflow: prefer typesafe containers
The typesafe containers have been around for quite a while now and
haven't gone up in a blaze of flames, so let's add a "strong
recommendation" to use them for new code and refactors.

For the nhrpd custom lists I'm already working to remove them; meanwhile
the old skiplists are primarily used in RFAPI (4 users outside of that),
so those could be next.

What remains are the old `list_*` and `hash_*`, which have >300 and >100
users respectively, making them a much harder problem to tackle.  And
the new hash implementation doesn't have the same level of
debug/introspection yet (it's on my TODO.)

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-09-22 12:09:47 +02:00
David Lamparter
e5af0fc869 doc/developer: add warning pointers
These two warnings are easy to get confused by, note down some pointers
on what they actually mean.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-09-02 13:00:35 +02:00
David Lamparter
dc1c0bc2b3 workflow: document release scheduling discussed
As discussed in the weekly meeting today, this is what we're trying to
work with for the time being.

(Date calculator included as a bonus goodie ;)

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-08-11 16:37:46 +02:00
David Lamparter
424117e52c doc/workflow: YANG is a hard requirement
The text didn't reflect the YANG requirement decision yet.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-07-07 15:48:39 +02:00
David Lamparter
b6660a6527 doc/workflow: add guidelines for config knobs
This is pretty much common sense ("runtime knobs are easier to adjust
than a compile-time setting"), but maybe it should be said just for
reference.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-07-07 14:57:00 +02:00
Igor Ryzhov
dc47f2e726 doc: remove redundant index directives
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2021-05-18 15:29:59 +03:00
Quentin Young
7bd4560bbd doc: describe acceptable commit messages
Update workflow.rst to state that commit messages consisting solely of
program output, or that otherwise fail to adequately summarize the
changes being made, are unacceptable.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-04-09 12:55:33 -04:00
Mark Stapp
eb3e4dc35c
Merge pull request #8128 from qlyoung/docs-cleanup
General docs cleanup
2021-02-24 16:53:42 -05:00
Quentin Young
e1ac6ff442 doc: update docs on docs
- Don't document 'no' commands
- Don't use .. index:: for clicmds
- Don't document all possible variants

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-02-23 15:43:13 -05:00
Quentin Young
7533cad751 *: remove more sprintf()
Should be just a couple non-development, non-test occurrences of this
function left now.

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2021-02-09 15:40:40 -05:00
Mark Stapp
41cb383f3a doc: remind not to include 'no' in cli doc index statements
Remind folks not to include the 'no' in cli doc index lines.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-01-12 13:29:08 -05:00
Quentin Young
3656e87b6b doc: document use of black for python formatting
Also moves "Exceptions" for C code under the C subsection.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-08 12:53:13 -04:00
Donatas Abraitis
c4c3330652
Merge pull request #6693 from qlyoung/doc-value-initialization-practices
Document value initialization practices
2020-07-08 11:04:14 +03:00
Quentin Young
431dd37e6f doc: remove trailing whitespace
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07 14:02:35 -04:00
Quentin Young
2787347dfe doc: note preferences for value initialization
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07 14:02:29 -04:00
Quentin Young
47563324c3 doc: specify output for json commands w/ no output
JSON commands should always return valid JSON

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-06 12:07:33 -04:00