Comments (3)
There is even open change request on Gerrit from Ole T. which adds support for this (no idea why not merged yet).
I rebased gerrit change: vppapigen: include comments in json and pinged Ole about the status. He is fine with the patch but it has not been tested. @ondrej-fabry , can you please open a new issue & test that this patch works with GoVPP?
from govpp.
The very best thing we could do for usability is to get the *.api comments captured into the json files so we could then convert them to comments on the generated APIs. The usability, particularly to users who aren't in vpp code day in and day out would be huge.
from govpp.
The very best thing we could do for usability is to get the *.api comments captured into the json files so we could then convert them to comments on the generated APIs. The usability, particularly to users who aren't in vpp code day in and day out would be huge.
Totally agree here. There is even open change request on Gerrit from Ole T. which adds support for this (no idea why not merged yet).
However, that is not really what this issue is about. This issue is about creating user guide document for using GoVPP - how to call VPP API and use Stats API in general. The specific API messages and their usage/comments are out of scope and can rather be tracked in another issue.
from govpp.
Related Issues (20)
- Support VPP API comments HOT 1
- Update GoVPP info on FD.io & VPP docs websites HOT 3
- Investigate intermittent failure of TestTraceEnabled HOT 2
- go.fd.io/govpp/extras cannot be imported HOT 15
- cannot parse high u64 default values in the API files HOT 3
- Fix: memory leak in receiveReplyInternal function
- [extras] Add documentation for govpp/extras and govpp/extras/gomemif HOT 3
- support for .tar.gz archives as input of govpp apigen
- Fix failing build for integration tests due removed version of package HOT 1
- Improve compatibility checking
- Stream.recvReply function is stuck on vpp disconect. HOT 2
- Question: missing binary API reply with sequence number HOT 5
- Function WaitReady does not wait if socket dir does not exist
- Move generated binapi
- [extras] The gomemif library struggles with high throughput when using interrupt mode.
- Skip CI tests for PRs updating docs only HOT 1
- Add linter for Markdown files
- verify generated code in `binapi` directory are up-to-date with the selected VPP version
- ubuntu 22.04 apt update issue after adding the repo HOT 1
- no server example? HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from govpp.