proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-05-02 07:06:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
17,398 Commits 4 Branches 191 Tags 125 MiB
f4bcc72f99
Commit Graph

45 Commits

Author SHA1 Message Date
Quentin Young
f4bcc72f99 doc: update release procedure docs 
Add a lot of detail and update some outdated stuff.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2019-10-18 18:50:10 +00:00
Quentin Young
6f7a92544b doc: add style guide for YANG 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2019-10-09 19:30:10 +00:00
David Lamparter
81047bc5b7 doc: add frr_{each,with} to coding style 
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
 2019-09-03 17:18:35 +02:00
David Lamparter
ca9dfee009 workflow: document current C++ approach 
Signed-off-by: David Lamparter <equinox@diac24.net>
 2019-06-04 18:12:19 +02:00
David Lamparter
ac97970d24 workflow: update notes for release numbering 
People have been complaining our major version number increases to
fast and/or in a meaningless way...

Signed-off-by: David Lamparter <equinox@diac24.net>
 2019-06-04 18:04:26 +02:00
David Lamparter
81af03178b doc: add libtool note 
(and document that ASAN/MSAN/TSAN are mutually exclusive while at it)

Signed-off-by: David Lamparter <equinox@diac24.net>
 2019-06-02 20:44:38 +02:00
David Lamparter
da1a93983a
Merge pull request #3998 from pguibert6WIND/workflow_bug_fixes_older 
doc: permit maintenance on more than the 2 last maintenance releases
 2019-03-26 16:45:48 +01:00
David Lamparter
cdec5d956b
Merge pull request #3996 from qlyoung/doc-move-rpm-to-devdocs 
move rpm build doc to devdocs
 2019-03-23 14:22:49 +01:00
Philippe Guibert
07ff01d255 doc: permit maintenance on more than the 2 last maintenance releases 
it is possible to do some ponctual backporting of bug fixes, on older
than the 2 last maintenance releases.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
 2019-03-22 15:56:11 +01:00
Quentin Young
924947e412 doc: fix underline level 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2019-03-21 18:50:25 +00: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
Philippe Guibert
e2abcff860 doc: add a community rule to permit usage of GPLv3 
explain why GPLv3 must be permitted, and explicitly mention that code
not compatible with GPLv3 is prohibited.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
 2018-12-17 12:14:48 +01:00
Philippe Guibert
bd2b4fc346 doc: change workflow to support long term maintenance branches 
Add in the workflow the possibility to do long term support.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
 2018-11-13 17:38:53 +01:00
Quentin Young
e12ea4bb86 doc: document CLI deprecation period length 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-09-17 16:48:11 +00:00
Lou Berger
7e678379ed doc: add comment on closing PRs 
Signed-off-by: Lou Berger <lberger@labn.net>
 2018-08-29 09:48:12 +02:00
Lou Berger
01bf2ccbdb doc: add comment on PR title and description 
Signed-off-by: Lou Berger <lberger@labn.net>
 2018-08-29 09:48:12 +02:00
Lou Berger
e60dd6cae4 doc: update doc to no longer requires use of VERSION_TYPE_DEV 
Signed-off-by: Lou Berger <lberger@labn.net>
 2018-07-10 16:19:30 -04:00
Quentin Young
590a7368df doc: add dev docs on code review practices 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-07-09 18:32:01 +00:00
Quentin Young
b682099337 doc: update workflow.rst 
* Rewrap lines to 80 characters
* Update some portions to reflect current practices
* Clean up some formatting (indent, markup, etc)
* Reorganize sections on patch submission
* Remove link to nonexistent github wiki page

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-06-15 18:38:38 +00:00
MasterofJOKers
3f4f5b0437 doc: Correct wiki URL in workflow-documentation 
The organization on github is called "FRRouting".

Signed-off-by: MasterofJOKers <joker@someserver.de>
 2018-06-14 09:33:32 +02:00
Mark Stapp
c964e51136 doc: fix broken link to 'code formatting' section 
Mismatch in rst source was producing a dead link in the html output

Signed-off-by: Mark Stapp <mjs@voltanet.io>
 2018-06-05 15:32:07 -04:00
Rafael Zalamena
a6528075a8
Merge pull request #2039 from qlyoung/docuser 
doc: more cleanup, config syntax highlighting
 2018-04-12 18:02:22 -03:00
Quentin Young
d3c2e31675
doc: update style exceptions list 
And make note of future policy

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-04-10 13:19:32 -04:00
Quentin Young
e1a8a773a2
Merge pull request #1883 from LabNConsulting/working/master/community-document-checkpatch 
COMMUNITY.md: document more details of current coding style process
 2018-04-10 12:26:08 -04:00
Quentin Young
d5403d4f40
doc: add frr.conf syntax highlighting 
Vincent Bernat has written a small Pygments lexer for IOS / Quagga
config files that works just as well on FRR stuff. Pulled that into our
docs with his blessing.

Also changed the background color on our code blocks away from that
kinda ugly green to gray, which looks way better with the syntax
highlighting changes that are about to happen in the next commit.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-04-09 17:30:53 -04:00
G. Paul Ziemba
115e70a1b7 doc: workflow.rst: more details of current coding style process 
Signed-off-by: G. Paul Ziemba <paulz@labn.net>
 2018-04-07 17:24:23 -07:00
Lou Berger
110bb12121 doc: add note and example on use of VERSION_TYPE_DEV and CONFDATE 
Signed-off-by: Lou Berger <lberger@labn.net>
 2018-04-03 14:04:31 -04:00
Martin Winter
a329ad23cf
Merge pull request #1882 from LabNConsulting/working/master/community-dismiss 
workflow.rst: add note that author's shouldn't delete a comment or review
 2018-04-03 15:54:27 +01:00
Lou Berger
cab3f81198 doc: add note on use of scripts to enable immediate removale deprecated APIs/macros 
Signed-off-by: Lou Berger <lberger@labn.net>
 2018-03-30 12:13:54 -04:00
Quentin Young
28ac5a0381
tools, doc: update checkpatch for u_int_* 
* Checkpatch.pl now checks for nonstandard integral types
* Add shell script to replace all nonstandard types with their standard
  counterparts in C source files
* Document usage of types, mention conversion script

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-03-27 15:00:23 -04:00
Lou Berger
22265b3584 developer: workflow.rst - fix typo 
Signed-off-by: Lou Berger <lberger@labn.net>
 2018-03-27 08:11:48 -04:00
Lou Berger
493e3eed5d developer: workflow.rst - add text on how to respond to reviews/comments 
add note that author's shouldn't remove a comment or review.
           also add a note that automatically generated comments can
           be deleted by authors and others when such comments are not
           the most results from that automated comment source.

Signed-off-by: Lou Berger <lberger@labn.net>
 2018-03-27 08:08:15 -04:00
Quentin Young
9e00128623
doc: document sanitizers & scanners 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-03-22 14:55:13 -04:00
Russ White
c6323200a7
Merge pull request #1935 from qlyoung/doc-how-to-style 
doc: document code style tools
 2018-03-21 14:41:44 -04:00
Quentin Young
2780ae0c5c
doc: use not ` for :file: 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-03-21 12:34:51 -04:00
Quentin Young
281ba953fe
doc: document code style tools 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-03-19 16:22:53 -04:00
Quentin Young
c804874aca
frr, doc: Move COMMUNITY.md to doc/developer/workflow.rst 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-03-19 13:56:43 -04:00
Quentin Young
c91e9b8f74
doc: note dependencies necessary to build docs 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-02-02 16:59:52 -05:00
Quentin Young
9de103f0c9
doc: document documentation 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-02-02 15:19:04 -05:00
Quentin Young
05102ddc45
doc: move dev doc figures to figures/ 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2018-01-31 10:31:15 -05:00
Quentin Young
ab51ead08e
Revert "doc: add note to document practice changes in docs" 
Lou wrote his own clause so we're using that one

This reverts commit 558669e970.
 2017-12-14 16:23:50 -05:00
Quentin Young
8ce7861f45
doc: add clause for documenting 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2017-12-14 16:23:49 -05:00
Quentin Young
558669e970
doc: add note to document practice changes in docs 
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2017-12-11 16:12:07 -05:00
Quentin Young
b22ba015ef
doc: more organizing & updating 
* Add chapter on BGPD
* Add diagram for git workflow
* Convert next-hop tracking documents to ReST
* Update & organize workflow document
* Move ldpd docs back up to the parent directory

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2017-12-08 18:30:14 -05:00
Quentin Young
d1890d041e
doc: begin developer's manual 
* Move doc/code/ -> doc/developer/
* Move disparate code documentation to doc/developer/
* Convert Markdown docs to reStructuredText
* Organize docs into Sphinx tree
* Move build docs -> doc/developer/
* Change build doc titles to fit under Building subsection of manual

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
 2017-12-08 14:08:44 -05:00