Change in osmo-gsm-manuals[master]: vty reference: allow reference XML generated at build time

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

neels gerrit-no-reply at lists.osmocom.org
Mon May 25 21:01:53 UTC 2020


neels has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/18362 )

Change subject: vty reference: allow reference XML generated at build time
......................................................................


Patch Set 2:

> Patch Set 2:
> 
> That's what I'm not getting. We either move to generate it from builddir or keep it generated in srcdir, but why checking both? I'm simply asking if you find any reason for that.

Obviously, if we change osmo-gsm-manuals.git now to only build the XML ref from binary, we would be forced to change every osmo*.git at the same time. We are not ready to build *every* osmo program's XML ref from built binary:

- We first need to introduce --vty-ref-xml cmdline switches in every program.
- Switching to generate XML during build also requires individual makefile rules
  in every git repos -- obviously osmo-gsm-manuals cannot know the name and location
  of all osmo binaries everywhere.

I believe the best way forward is to still find the XML reference in the source tree by default.
Each git repos that is ready can switch to generating from binary during build time when it is ready.
Then we don't need to do one massive switch that is then backwards incompatible.

(Even if we would, in a massive effort, switch all our git repositories to generating XML ref at build time, then we would not be able to build older manuals with osmo-gsm-manuals master. Plus, any repos out there that we forgot about, or that someone else may have created that is depending on osmo-gsm-manuals would stop working all of a sudden.)

Hence this patch introduces a BUILT_REFERENCE_XML to add a dependency in case the caller needs it. And also it looks in both srcdir and builddir for the *reference.xml file that would so far always be in srcdir.

At first I had this solved by a simple

  $(ls -1 $(srcdir)/vty/*reference.xml $(builddir)/vty/*reference.xml)

but the added script makes sure that we don't barf confusing error output, and that we don't get confused by ls aliases or env config.


-- 
To view, visit https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/18362
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Change-Id: I613d692328050a036d05b49a436ab495fc2087ba
Gerrit-Change-Number: 18362
Gerrit-PatchSet: 2
Gerrit-Owner: neels <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: neels <nhofmeyr at sysmocom.de>
Gerrit-CC: pespin <pespin at sysmocom.de>
Gerrit-Comment-Date: Mon, 25 May 2020 21:01:53 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: No
Gerrit-MessageType: comment
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20200525/1e513159/attachment.htm>


More information about the gerrit-log mailing list