Feature #3695

generate VTY reference manuals from 'make' directly

Added by neels 28 days ago. Updated 9 days ago.

Target version:
Start date:
Due date:
% Done:


Spec Reference:


I just realize that after #3385 (move manuals into project repositories), we can actually generate the VTY reference files on-the-fly when building the manuals and don't need to commit the vty reference XML (and don't need to manually keep that updated, which we hardly ever did).
A prerequisite would be to have osmo-python-tests installed, so the makefile can invoke -X.

An alternative which I think is much nicer anyway would be a new cmdline option in each binary that generates this VTY reference to stdout directly, so that we don't need to invoke a telnet nor provide a config file. Like how --version works.
We can then deprecate generating the reference from the vty and also remove the -X option.

Related issues

Follows Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryIn Progress2018-07-06


#1 Updated by neels 28 days ago

  • Due date set to 07/09/2018
  • Start date changed from 11/14/2018 to 07/09/2018
  • Follows Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repository added

#2 Updated by neels 28 days ago

  • Assignee set to osmith

laforge : assigning this to osmith, please change that if it makes no sense.

#3 Updated by osmith 27 days ago

  • Due date deleted (07/09/2018)
  • Start date deleted (07/09/2018)

(removed due date and start date that was set in the past)

#4 Updated by osmith 9 days ago

We have a Jenkins job, that builds each project whenever commits land in master (master-builds.yml, see also). Some of these are built for multiple axes, which means multiple versions will be built with different configure flags enabled. Right now, we have configured the scripts to build the manuals with the fastest job (where the additional features are turned off), so it goes through the fastest way. See the discussion here:

However, neels noted that when we will implement automatic VTY reference manual generation, we would want to do this with a complete build, so we get a full VTY reference manual for all commands. So this would need to be changed as part of this issue.

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)