Home Page

MAME Linux documentation

Posted By: Stiletto

MAME Linux documentation - 07/15/20 10:39 PM

MAME's Linux documentation - aka the MAN files:
https://github.com/mamedev/mame/tree/master/docs/man

Could one of our friendly Linux devs or package maintainers please check that the MAN files are still in sync with https://github.com/mamedev/mame/tree/master/docs/source / https://docs.mamedev.org/
at some point? And if not, re-sync them?

It doesn't need to be right away, but it would be nice to know if they were in sync. We do have people who tend to look after such things but most of them are Windows users. smile
Posted By: wallyweek

Re: MAME Linux documentation - 08/08/20 09:08 AM

I'm pretty sure they are not.

I've been the (unofficial) maintainer for them since SDLMame has been merged into the main tree, but I've given up at some point because it was too much a waste of time to dig into the code each time to look for changes to switches. frown

I've considered using some tool to build them from docs source files, but this looks no trivial task as well. shocked

Syncing them one-off would take time, again wasted as I guess the proper way to keep them in sync would be to consider them part of the documentation itself, i.e. creating kind of a "docs team" working side by side with the developers to update the documentation _before_ each new release and structuring docs source files in a way that turns them into useful man sources too (my 2-cents). smile
Posted By: Firehawke

Re: MAME Linux documentation - 08/11/20 02:18 AM

Give me about another 10-15 minutes at most and I should have something useful to say on this.
Posted By: Firehawke

Re: MAME Linux documentation - 08/11/20 02:41 AM

Okay. It should be easy to generate manfiles from the docs (now that I've fixed the manfile compilation) by doing "make man" from the docs folder. You'll need Sphinx and Read the Docs installed; see https://docs.mamedev.org/initialsetup/compilingmame.html#compiling-the-documentation for details on requirements.

This has been supported ever since the new docs were created.
Posted By: Vas Crabb

Re: MAME Linux documentation - 08/11/20 06:04 AM

I’m not sure it’s the best way to do it though – it’s not really structured the way you’d want man pages to be. The man pages should really be a summary of usage options, and if the RST docs are compiled to anything to be installed with a Linux package, it would be HTML or PDF to install in /usr/share/doc/mame.
© 2020 Forums