Commit Graph

51 Commits

Author SHA1 Message Date
David Lamparter
de75bdc37b doc: add unique-id & backtrace user docs
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-11-10 15:30:56 +01:00
anlancs
7aa6fb2d6a doc: fix some compile warning
domainname is a merge conflict: it is duplicated, so delete it.
bgp content is a compille warning and wrongly display, so fix it.

Signed-off-by: anlancs <anlan_cs@tom.com>
2021-06-28 14:36:45 +08:00
David Lamparter
9b802bf44f doc: explain the new service cputime... commands
These are user tunable, even though most users hopefully don't need to
touch them.

Signed-off-by: David Lamparter <equinox@diac24.net>
2021-06-24 16:42:59 +02:00
Donald Sharp
2afd15f5c6
Merge pull request #8656 from opensourcerouting/xref-5424-prep-2
lib: preparations for RFC5424 syslog support
2021-06-23 06:08:41 -04:00
Russ White
7fd86e2811
Merge pull request #8820 from anlancs/master-vtysh-hostname
doc: add a note of hostname/domainname for vtysh
2021-06-22 10:06:05 -04:00
David Lamparter
9c2aa91921 lib: de-conflict log-filter CLI command
`log-filter WORD` was giving me a serious headache since it also matches
`log WORD` due to the way the CLI token handling works.  This meant that
a mistyped `log something` command would silently be interpreted as a
filter string, causing me serious headscratching and WTFs until I
figured what was going on.

Remove this UX pitfall so noone else falls into it.  (Since the command
was never saved to config, renaming it shouldn't cause trouble.)

[Also I apparently forgot to update the docs when I transferred this
over to the new zlog bits...]

TODO for a rainy day:  since we collect all the CLI commands anyway, we
should warn somewhere for "2nd level ambiguous" commands like this.

Signed-off-by: David Lamparter <equinox@diac24.net>
2021-06-18 20:56:53 +02:00
anlancs
063f44007e doc: add a note of domainname
Signed-off-by: anlancs <anlan_cs@tom.com>
2021-06-10 18:16:33 +08:00
anlancs
8f58056c0e doc: add a note of hostname/domainname for vtysh
These names are saved in current vtysh's memory, can't and needn't be saved into
configure file by watchfrr's 'vtysh -w`.

Signed-off-by: anlancs <anlan_cs@tom.com>
2021-06-10 10:40:28 +08:00
Mark Stapp
7c945dff61 lib: add 'log immediate-mode' cli
Add a cli to control immediate-output mode for logs and debugs.
Add this to the user docs also.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-04-20 12:55:08 -04:00
David Lamparter
1df904706c
Merge pull request #8288 from qlyoung/readd-space-support-to-find-command 2021-04-13 02:22:46 +02:00
Igor Ryzhov
aa270404fc doc: add "show memory [DAEMON]"
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2021-04-09 11:30:49 +03:00
Quentin Young
fdd40d514d doc: update docs for find REGEX... command
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-04-07 13:40:00 -04:00
Quentin Young
03750f1eb6 doc: remove 'no' form of commands
These don't need to be documented, most of the time they are obvious,
when they aren't the behavior can just be described in the command
description.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-02-22 14:38:21 -05:00
Quentin Young
8ed09fbf5a doc: automatically generate index entries for cli
- Generate index entries automatically
- Remove manual command index entries
- Clean up a few other manual index entries

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-02-22 14:38:21 -05:00
Donald Sharp
a65f4b5dc0 doc, vtysh: Add a show history command
Dump the cli history to the user in vtysh when a `show history`
command is entered.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-12-03 12:36:29 -05:00
Quentin Young
e4cc866f0a
Merge pull request #7551 from mjstapp/fix_doc_no_index
doc: don't index 'no' forms of commands
2020-11-20 12:15:31 -05:00
Mark Stapp
1a9f340b6b lib: add startup option to limit fds
Add a startup-time option to limit the number of fds used
by the thread/event infrastructure. If nothing is configured,
the system ulimit is used.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-11-18 15:34:35 -05:00
Mark Stapp
3d13052da3 doc: don't index 'no' forms of commands
Many index entries used '[no] xxx' or 'no xxx', some had both
positive and 'no' forms. Clean that up mostly - index positive
form of commands only.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-11-17 16:58:43 -05:00
Mark Stapp
d71b915695 doc: fix sphinx complaint about indent levels
There was an inconsistency in the characters used for the second
level of title/section hierarchy - fix it.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-11-09 12:44:44 -05:00
Quentin Young
d7432defac doc: explain integrated config
This is poorly documented and confusing to users

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-11-04 17:29:58 -05:00
Donald Sharp
32d9e333b7 doc: Update Documentation to note Solaris Unsupported status
With the change of Solaris going from Supported -> UnSupported
the documentation needed to be updated to reflect the reality
on the ground.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-09-21 10:02:20 -04:00
David Lamparter
0eb5f93863 doc: new logging subsystem
Signed-off-by: David Lamparter <equinox@diac24.net>
2020-04-01 06:53:26 +02:00
David Lamparter
a048cda55f doc: document defaults mechanism
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-12-06 15:13:32 +01:00
Donatas Abraitis
038984fd3c doc: Add banner motd <file|line> sections
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2019-10-31 15:02:53 +02:00
Donald Sharp
f75e802d8a *: Allow disabling of getrusage calls
getrusage, in a heavily stressed system, can account for
signficant running time due to process switching to the kernel.
Allow the end-operator to specify `--disable-cpu-time` to
avoid this call.  Additionally we cause `show thread cpu` to
not show up if this is selected.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-10-16 13:34:59 -04:00
Stephen Worley
018fa5f85d doc: Add a performance note for log filtering
Add a not under the log-filter command to indicate
that, while filtering reduces load on the system by
large margins, there may still be a small performance
hit from filtering those.

Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
2019-06-25 10:49:43 -04:00
Stephen Worley
c103b19f6d doc: Add docs for log-filter and show log-filter
Add some user documentation for applying/deleting/showing
log filters with the new commands.

Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
2019-06-19 17:20:24 -04:00
Donald Sharp
6ed859503d doc: Update the documentation to reflect -N changes
The -N <namespace> option is now used to control the location
of various control files and sockets.  Update the documentation
to reflect this.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-06-04 19:52:46 -04:00
Donald Sharp
80d02adbb0 doc: Add doc for new configure option
Add documentation for the '--command-log-always' daemon cli
and how to use it.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-31 10:06:42 -04:00
Donald Sharp
8b1148bf59 doc: Add 'show thread cpu' and 'show thread poll' documentation
Add some very basic 'show thread cpu' and 'show thread poll'
documentation to our system.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-24 08:24:18 -04:00
Dinesh Dutt
982589a31a doc: Modify documentation to reflect new configure changes
This is the document changes to reflect the configure option
making `terminal` optional.

Signed-off-by: Dinesh Dutt <dd.ps4u@gmail.com>
2019-05-07 21:06:00 -04:00
Ruben Kerkhof
56f0bea718 doc: fix a couple of typos
Found with https://github.com/codespell-project/codespell

Signed-off-by: Ruben Kerkhof <ruben@rubenkerkhof.com>
2019-03-20 20:08:33 +01:00
Renato Westphal
1c2facd12d lib: introduce new northbound API
Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-27 16:16:12 -02:00
David Lamparter
0a62b87392 doc: add "show memory" user documentation
Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-09 22:53:08 +02:00
Donald Sharp
3cf3e018a9 doc: Add --log-level documentation
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-19 09:06:37 -04:00
Donald Sharp
ed74ddf403 doc: Add some documentation for cli logging
Add some basic documentation for the new cli added to all daemons.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-19 08:43:59 -04:00
Quentin Young
8421b1401d doc: move find command docs to better spot
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:55:55 +00:00
Quentin Young
2da6ccc392 doc: clean up introductory user docs
* Update the list of protocol daemons from 5 to the current 13
* Rewrap and clean up formatting for lots of miscellaneous code blocks
* Improve English in various spots
* Update architecture description and diagram
* Remove duplicate information on reporting bugs

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
db910447b8 doc: reorganize into multiple toctrees
Use multiple toctrees to reorganize the user docs into logical sections.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
4c54343ffb doc: add docs on | actions, find command
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-06 19:51:34 +00:00
Pascal Mathis
322e2d5c69
lib: Ported 'no (enable) password' from stable/3.0
The pull request #1545 from @donaldsharp introduced the command 'no
password' to remove an existing terminal connection password.
Additionally, warnings have been added to both 'no password' and 'no
enable password' to make the user aware of any security implications.

It seems that this specific pull request was never merged against master
and got lost. This commit is a cherry-pick of d4961273cb with fixed
conflicts and updated documentation.

Thanks to @donaldsharp and @pogojotz for the original PR.

Signed-off-by: Pascal Mathis <mail@pascalmathis.com>
2018-05-11 02:54:30 +02:00
Quentin Young
d1e7591eb2 doc: spelling fixes
* Run sphinxcontrib-spelling over docs
* Correct spelling errors
* Compile a dictionary for future spellchecking efforts

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-20 17:59:38 -04:00
Quentin Young
9eb95b3b0a
doc: use frr syntax highlighting
* Use highlighter added in previous commit
* Correct indentation where I came across it

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-09 17:30:57 -04:00
Quentin Young
c936589468
doc: cleanup daemon option flags
Short and long form options can be written on the same line, Sphinx
understands how to cross-reference using either one of them. Also
replace some - with _ where appropriate.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-09 17:30:47 -04:00
Quentin Young
0efdf0fe50
doc: clean up cross references
Format reference directives and roles to match best practices.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 16:33:14 -05:00
Quentin Young
d1a242fdbf
doc: cleanup multiple
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-29 12:16:20 -05:00
Quentin Young
29adcd5008
doc: fix cli documentation formatting
* Use new 'clicmd' directive / role
* Convert old style range syntax to new style

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 16:15:43 -05:00
Quentin Young
dc5564c76f
doc: cleanup installation instructions
Use program and option directives for CLI options

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 13:29:16 -05:00
Quentin Young
be46d28847
doc: use RST variable substitutions
In conf.py, extract & construct values for inline variables throughout
the docs. In the docs, use these inline variables in RST syntax.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:05:08 -05:00
Quentin Young
8d2098618c
doc: fixup basic.rst
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-22 16:30:56 -05:00