Previous Thread
Next Thread
Print Thread
MAME Linux documentation #117559 07/15/20 10:39 PM
Joined: Oct 2006
Posts: 986
S
Stiletto Online Content OP
Senior Member
OP Online Content
Senior Member
S
Joined: Oct 2006
Posts: 986
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

Last edited by Stiletto; 07/15/20 10:40 PM.
Re: MAME Linux documentation [Re: Stiletto] #117642 08/08/20 09:08 AM
Joined: Mar 2008
Posts: 154
wallyweek Offline
Senior Member
Offline
Senior Member
Joined: Mar 2008
Posts: 154
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


Master of Sarcastic Wit
Linux User #182984
Re: MAME Linux documentation [Re: wallyweek] #117651 08/11/20 02:18 AM
Joined: May 2006
Posts: 130
F
Firehawke Offline
Senior Member
Offline
Senior Member
F
Joined: May 2006
Posts: 130
Give me about another 10-15 minutes at most and I should have something useful to say on this.

Re: MAME Linux documentation [Re: Stiletto] #117653 08/11/20 02:41 AM
Joined: May 2006
Posts: 130
F
Firehawke Offline
Senior Member
Offline
Senior Member
F
Joined: May 2006
Posts: 130
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.

Last edited by Firehawke; 08/11/20 02:44 AM.
Re: MAME Linux documentation [Re: Stiletto] #117655 08/11/20 06:04 AM
Joined: Feb 2004
Posts: 2,167
Vas Crabb Offline
Very Senior Member
Offline
Very Senior Member
Joined: Feb 2004
Posts: 2,167
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.


Moderated by  R. Belmont 

Who's Online Now
4 registered members (robcfg, 3 invisible), 32 guests, and 2 spiders.
Key: Admin, Global Mod, Mod
ShoutChat Box
Comment Guidelines: Do post respectful and insightful comments. Don't flame, hate, spam.
Forum Statistics
Forums9
Topics8,810
Posts115,943
Members4,914
Most Online890
Jan 17th, 2020
Powered by UBB.threads™ PHP Forum Software 7.7.3