[ptxdist] How to add docs to target without going insane

[ptxdist] How to add docs to target without going insane

[Dennis.Herbrich]

Greetings to the list!

We're creating a not-quite-embedded Linux with the help of the current
ptxdist version, and it annoys me to no end to not have the manpages
of all those nifty diagnostic tools available on the target. I have to
admit I do not know all the tcpdump switches by heart, and neither do
the poor sods who else attempt to diagnose problems on the target,
and an internet connection isn't always available.

Long story short: How do I elegantly package all included documentation
for all installed packages for deployment on the target?
I don't care if the docs are included in their respective package, or
in one huge "manpages.ipk".

I do not see myself effectively replacing EVERY upstream rule file, as
that would be an obvious maintenance nightmare (unless that patch
torrent would be accepted upstream ;)), and picking stuff from
the build-target directories seems too much guesswork for my taste.
The app's "make install" still knows best what to install where.

Any suggestions?

Thanks in advance,
  Dennis Herbrich

Development Engineer
Hytera Mobilfunk GmbH
Fritz-Hahne-Str. 7
D-31848 Bad Muender
www.hytera.de
Office: +49 5042 998 339
Fax: +49 5042 998 105
mailto:dennis.herbrich@hytera.de
Geschäftsfuehrer / President: Matthias Klausing, Sitz der Gesellschaft / 
Company's Place of Business: Bad Muender, Registereintrag / Commercial 
Register No. Amtsgericht / Local Court Hannover: HRB 100300, 
Umsatzsteuer-Identifikationsnummer (USt-IdNr.) / VAT Identification No.: 
DE 115 447 987, Elektro-Altgeraete Register (EAR) / WEEE Register No.: DE 
187 048 

-- 
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] How to add docs to target without going insane

[Jürgen Beisert]

Hi Dennis,

On Thursday 15 August 2013 12:56:00 Dennis.Herbrich@hytera.de wrote:
> Greetings to the list!
>
> We're creating a not-quite-embedded Linux with the help of the current
> ptxdist version, and it annoys me to no end to not have the manpages
> of all those nifty diagnostic tools available on the target. I have to
> admit I do not know all the tcpdump switches by heart, and neither do
> the poor sods who else attempt to diagnose problems on the target,
> and an internet connection isn't always available.
>
> Long story short: How do I elegantly package all included documentation
> for all installed packages for deployment on the target?
> I don't care if the docs are included in their respective package, or
> in one huge "manpages.ipk".
>
> I do not see myself effectively replacing EVERY upstream rule file, as
> that would be an obvious maintenance nightmare (unless that patch
> torrent would be accepted upstream ;)), and picking stuff from
> the build-target directories seems too much guesswork for my taste.
> The app's "make install" still knows best what to install where.

Package's "install" stage should also install the man pages (only if enabled, 
for most packages we try to avoid it, because it takes too much time and 
nobody uses the man pages on the target).
Take a look into the 
corresponding "platform-<platform>/packages/<package>[/usr]/share/man" 
directories. If there are man pages installed you can adapt the package's rule 
file to also include these files into the IPKG/OPKG and target's filesystem. 
Refer the 'install_copy' and/or 'install_tree' macros how to do so.

Regards,
Juergen

-- 
Pengutronix e.K.                              | Juergen Beisert             |
Linux Solutions for Science and Industry      | http://www.pengutronix.de/  |

-- 
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] How to add docs to target without going insane

[Uwe Kleine-König]

On Mon, Aug 19, 2013 at 03:18:48PM +0200, Jürgen Beisert wrote:
> Hi Dennis,
> 
> On Thursday 15 August 2013 12:56:00 Dennis.Herbrich@hytera.de wrote:
> > Greetings to the list!
> >
> > We're creating a not-quite-embedded Linux with the help of the current
> > ptxdist version, and it annoys me to no end to not have the manpages
> > of all those nifty diagnostic tools available on the target. I have to
> > admit I do not know all the tcpdump switches by heart, and neither do
> > the poor sods who else attempt to diagnose problems on the target,
> > and an internet connection isn't always available.
> >
> > Long story short: How do I elegantly package all included documentation
> > for all installed packages for deployment on the target?
> > I don't care if the docs are included in their respective package, or
> > in one huge "manpages.ipk".
> >
> > I do not see myself effectively replacing EVERY upstream rule file, as
> > that would be an obvious maintenance nightmare (unless that patch
> > torrent would be accepted upstream ;)), and picking stuff from
> > the build-target directories seems too much guesswork for my taste.
> > The app's "make install" still knows best what to install where.
> 
> Package's "install" stage should also install the man pages (only if enabled, 
> for most packages we try to avoid it, because it takes too much time and 
> nobody uses the man pages on the target).
> Take a look into the 
> corresponding "platform-<platform>/packages/<package>[/usr]/share/man" 
> directories. If there are man pages installed you can adapt the package's rule 
Also you can read them from there using

	man -l -Tutf-8 platform-<platform>/packages/<package>/usr/share/man/man1/tralala.1 | less

(untested).

Best regards
Uwe

-- 
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |

-- 
ptxdist mailing list
ptxdist@pengutronix.de