657c5b6cad
The 'show online-help' produces XML output with <node id="..."> ids. We reference those from the osmo-gsm-manuals. Instead of numeric IDs coming from internal code, rather use a human-readable node ID -- referencing id='config-msc' is much easier than referencing id='23'. Add a char name[] to struct cmd_node, to hold this name. This may be provided upon struct definition. Since callers of the VTY API so far don't have a name yet, we would need to add names everywhere to get meaningful node IDs. There is a way to get node ID names without touching dependent code: My first idea was to find out which command entered the node, i.e. command 'msc' enters the MSC_NODE. But it is impossible to derive which command entered which node from data structs, it's hidden in the vty command definition. But in fact all (TM) known API callers indeed provide a prompt string that contains a logical and human readable string name. Thus, if the name is unset in the struct, parse the prompt string and strip all "weird" characters to obtain a node name from that. We can still set names later on, but for now will have meaningful node IDs (e.g. 'config-msc' from '%s(config-msc)# ') without touching any dependent code. When VTY nodes get identical node names, which is quite possible, the XML export de-dups these by appending _2, _3,... suffixes. The first occurence is called e.g. 'name', the second 'name_2', then 'name_3', and so forth. If a node has no name (even after parsing the prompt), it will be named merely by the suffix. The first empty node will become id='_1', then '_2', '_3', and so forth. This happens for nodes like VIEW_NODE or AUTH_NODE. If this is merged, we need to adjust the references in osmo-gsm-manuals.git. This can happen in our own time though, because we manually create the vty reference xml and copy it to the osmo-gsm-manuals.git and then update the references from the vty_additions.xml. This anyway has to happen because currently the references tend to be hopelessly out of sync anyway, placing comments at wildly unrelated VTY commands. Change-Id: I8fa555570268b231c5e01727c661da92fad265de |
||
|---|---|---|
| contrib | ||
| debian | ||
| doc | ||
| include | ||
| m4 | ||
| src | ||
| tests | ||
| utils | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| COPYING | ||
| Doxyfile.codec.in | ||
| Doxyfile.coding.in | ||
| Doxyfile.core.in | ||
| Doxyfile.gb.in | ||
| Doxyfile.gsm.in | ||
| Doxyfile.vty.in | ||
| Makefile.am | ||
| README.md | ||
| TODO-RELEASE | ||
| configure.ac | ||
| git-version-gen | ||
| libosmocodec.pc.in | ||
| libosmocoding.pc.in | ||
| libosmocore.pc.in | ||
| libosmoctrl.pc.in | ||
| libosmogb.pc.in | ||
| libosmogsm.pc.in | ||
| libosmosim.pc.in | ||
| libosmovty.pc.in | ||
| osmo-release.mk | ||
README.md
libosmocore - set of Osmocom core libraries
This repository contains a set of C-language libraries that form the core infrastructure of many Osmocom Open Source Mobile Communications projects.
Historically, a lot of this code was developed as part of the OpenBSC project, but which are of a more generic nature and thus useful to (at least) other programs that we develop in the sphere of Free Software / Open Source mobile communications.
There is no clear scope of it. We simply move all shared code between the various Osmocom projects in this library to avoid code duplication.
The libosmcoore.git repository build multiple libraries:
- libosmocore contains some general-purpose functions like select-loop abstraction, message buffers, timers, linked lists
- libosmovty contains routines related to the interactive command-line interface called VTY
- libosmogsm contains definitions and helper code related to GSM protocols
- libosmoctrl contains a shared implementation of the Osmocom control interface
- libosmogb contains an implementation of the Gb interface with its NS/BSSGP protocols
- libosmocodec contains an implementation of GSM voice codecs
- libosmocoding contains an implementation of GSM channel coding
- libosmosim contains infrastructure to interface SIM/UICC/USIM cards
- libosmotrau contains encoding/decoding functions for A-bis TRAU frames
Homepage
The official homepage of the project is https://osmocom.org/projects/libosmocore/wiki/Libosmocore
GIT Repository
You can clone from the official libosmocore.git repository using
git clone git://git.osmocom.org/libosmocore.git
There is a cgit interface at http://git.osmocom.org/libosmocore/
Documentation
Doxygen-generated API documentation is generated during the build process, but also available online for each of the sub-libraries at http://ftp.osmocom.org/api/latest/libosmocore/
Mailing List
Discussions related to libosmocore are happening on the openbsc@lists.osmocom.org mailing list, please see https://lists.osmocom.org/mailman/listinfo/openbsc for subscription options and the list archive.
Please observe the Osmocom Mailing List Rules when posting.
Contributing
Our coding standards are described at https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards
We us a gerrit based patch submission/review process for managing contributions. Please see https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit for more details
The current patch queue for libosmocore can be seen at https://gerrit.osmocom.org/#/q/project:libosmocore+status:open