-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cleanup OSPF API server docs #4176
Conversation
* Reflow to 80 columns * Improve markup * Add --apiserver option to example ospfd invocations * Add note on requirement of this option to use api server Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
💚 Basic BGPD CI results: SUCCESS, 0 tests failedResults table
For details, please contact louberger |
Continuous Integration Result: SUCCESSFULCongratulations, this patch passed basic tests Tested-by: NetDEF / OpenSourceRouting.org CI System CI System Testrun URL: https://ci1.netdef.org/browse/FRR-FRRPULLREQ-7325/ This is a comment from an automated CI system. CLANG Static Analyzer Summary
12 Static Analyzer issues remaining.See details at |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks great - just had a couple of text nits
doc/developer/ospf-api.rst
Outdated
recent). However, if the originating router first synchronizes the | ||
database before originating opaque LSAs, it will detect the older opaque | ||
LSA and can flush it first. | ||
opaque-capable neighbor. Thus, you cannot originate opaque LSAs of no neighbors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/of/if ?
doc/developer/ospf-api.rst
Outdated
database before originating opaque LSAs, it will detect the older opaque | ||
LSA and can flush it first. | ||
opaque-capable neighbor. Thus, you cannot originate opaque LSAs of no neighbors | ||
are present. If you try to originate even so no neighbor is ready, you will |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"even so no" -> "before any", or maybe "when no neighbors are ready"
doc/developer/ospf-api.rst
Outdated
@@ -326,8 +317,7 @@ The synchronous requests and replies have the following message formats: | |||
|
|||
image | |||
|
|||
The origin field allows to select according to the following types of | |||
origins: | |||
The origin field allows to select according to the following types of origins: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe "allows filtering based on origin" ?
@mjstapp Yeah, there are a lot of typos in here - I didn't really go over this doc for English correctness, I just reflowed the existing text to fit within 80 columns and added the I can certainly make a second pass over this at some point but I'm not really trying to spend time fixing grammar at the moment :) |
@qlyoung, @mjstapp I'm not sure we could modify the text like this. This text was originally available through a different web server that the Quagga one and never be include in the Quagga code tree. I got it with the help of the wayback machine and just reformat it without modify its contain (this is the purpose of the disclaimer). As the original text was not published under any License (CC or other), I think we need to explicitly mention our source if we modify the contain. |
understood -thanks for the explanation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
approving
Let's not merge this until Ralph gives us his blessing or we determine the copyright status. |
Ralph has kindly granted us GPLv2+ license to use this documentation, and requests that we keep a reference to his name. Add these facts to the documentation. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
We have Ralph's blessing, and explicit license under GPLv2+. For posterity:
Added notes reflecting these facts. Also did the typo pass @mjstapp, should be g2g now. |
💚 Basic BGPD CI results: SUCCESS, 0 tests failedResults table
For details, please contact louberger |
Continuous Integration Result: SUCCESSFULCongratulations, this patch passed basic tests Tested-by: NetDEF / OpenSourceRouting.org CI System CI System Testrun URL: https://ci1.netdef.org/browse/FRR-FRRPULLREQ-7351/ This is a comment from an automated CI system. CLANG Static Analyzer Summary
No Changes in Static Analysis warnings compared to base12 Static Analyzer issues remaining.See details at |
Continuous Integration Result: SUCCESSFULCongratulations, this patch passed basic tests Tested-by: NetDEF / OpenSourceRouting.org CI System CI System Testrun URL: https://ci1.netdef.org/browse/FRR-FRRPULLREQ-7350/ This is a comment from an automated CI system. CLANG Static Analyzer Summary
No Changes in Static Analysis warnings compared to base12 Static Analyzer issues remaining.See details at |
Fixes: #4138