Skip to content
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

Merged
merged 4 commits into from
Apr 24, 2019

Conversation

qlyoung
Copy link
Member

@qlyoung qlyoung commented Apr 22, 2019

Fixes: #4138

qlyoung added 2 commits April 22, 2019 20:22
* 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>
@LabN-CI
Copy link
Collaborator

LabN-CI commented Apr 22, 2019

💚 Basic BGPD CI results: SUCCESS, 0 tests failed

Results table
_ _
Result SUCCESS git merge/4176 5354eea
Date 04/22/2019
Start 16:55:13
Finish 17:18:56
Run-Time 23:43
Total 1813
Pass 1813
Fail 0
Valgrind-Errors 0
Valgrind-Loss 0
Details vncregress-2019-04-22-16:55:13.txt
Log autoscript-2019-04-22-16:55:56.log.bz2
Memory 446 445 374

For details, please contact louberger

@NetDEF-CI
Copy link
Collaborator

Continuous Integration Result: SUCCESSFUL

Congratulations, 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.
For questions and feedback in regards to this CI system, please feel free to email
Martin Winter - mwinter (at) opensourcerouting.org.


CLANG Static Analyzer Summary

  • Github Pull Request 4176, comparing to Git base SHA 8f19bc1
  • Base image data for Git 8f19bc1 does not exist - compare skipped

12 Static Analyzer issues remaining.

See details at
https://ci1.netdef.org/browse/FRR-FRRPULLREQ-7325/artifact/shared/static_analysis/index.html

Copy link
Contributor

@mjstapp mjstapp left a 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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/of/if ?

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
Copy link
Contributor

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"

@@ -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:
Copy link
Contributor

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" ?

@qlyoung
Copy link
Member Author

qlyoung commented Apr 23, 2019

@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 ---apiserver option.

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 :)

@odd22
Copy link
Member

odd22 commented Apr 23, 2019

@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.

@mjstapp
Copy link
Contributor

mjstapp commented Apr 23, 2019

@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.

Copy link
Contributor

@mjstapp mjstapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving

@qlyoung
Copy link
Member Author

qlyoung commented Apr 23, 2019

Let's not merge this until Ralph gives us his blessing or we determine the copyright status.

qlyoung added 2 commits April 24, 2019 17:37
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>
@qlyoung
Copy link
Member Author

qlyoung commented Apr 24, 2019

We have Ralph's blessing, and explicit license under GPLv2+. For posterity:

The code is already GPL and I give you permission to use the documentation under GPLv2+ as well (please keep a reference to my name).

Note that there exists also a tech report of the OSPF API (link) but the PDF is (no longer) available for some reason.

Keep up the good work!

All the best,

Ralph Keller

Added notes reflecting these facts. Also did the typo pass @mjstapp, should be g2g now.

@LabN-CI
Copy link
Collaborator

LabN-CI commented Apr 24, 2019

💚 Basic BGPD CI results: SUCCESS, 0 tests failed

Results table
_ _
Result SUCCESS git merge/4176 7c8c9c8
Date 04/24/2019
Start 14:05:14
Finish 14:29:00
Run-Time 23:46
Total 1816
Pass 1816
Fail 0
Valgrind-Errors
Valgrind-Loss
Details vncregress-2019-04-24-14:05:14.txt
Log autoscript-2019-04-24-14:05:59.log.bz2
Memory 431 434 374

For details, please contact louberger

@NetDEF-CI
Copy link
Collaborator

Continuous Integration Result: SUCCESSFUL

Congratulations, 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.
For questions and feedback in regards to this CI system, please feel free to email
Martin Winter - mwinter (at) opensourcerouting.org.


CLANG Static Analyzer Summary

  • Github Pull Request 4176, comparing to Git base SHA 8f19bc1

No Changes in Static Analysis warnings compared to base

12 Static Analyzer issues remaining.

See details at
https://ci1.netdef.org/browse/FRR-FRRPULLREQ-7351/artifact/shared/static_analysis/index.html

@NetDEF-CI
Copy link
Collaborator

Continuous Integration Result: SUCCESSFUL

Congratulations, 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.
For questions and feedback in regards to this CI system, please feel free to email
Martin Winter - mwinter (at) opensourcerouting.org.


CLANG Static Analyzer Summary

  • Github Pull Request 4176, comparing to Git base SHA 8f19bc1

No Changes in Static Analysis warnings compared to base

12 Static Analyzer issues remaining.

See details at
https://ci1.netdef.org/browse/FRR-FRRPULLREQ-7350/artifact/shared/static_analysis/index.html

@mjstapp mjstapp merged commit 850af7a into FRRouting:master Apr 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document OSPF API server better
6 participants