Commit Graph

245 Commits

Author SHA1 Message Date
AJR
b84397f786 Make -nonvram_save also inhibit saving of "battery" NVRAM for image devices 2019-02-19 20:47:39 -05:00
Vas Crabb
34ebe564b0 (nw) omission, formatting 2019-02-18 21:55:45 +11:00
Vas Crabb
8ffff5d2d3 (nw) misc stuff:
* Document cross-compilation options
* Use lowercase for some libraries that are lowercase in system32 on Windows anyway
* Make USE_BUNDLED_LIB_SDL2=0 not use the bundled SDL
2019-02-18 21:13:44 +11:00
cam900
e65f6d75e1 device_memory_interface.rst : Correct docs 2019-02-18 00:34:05 +11:00
Olivier Galibert
7e53d69069 Add svg->pdf conversion support 2019-01-28 11:09:20 +01:00
Vas Crabb
9ce054c04b slight logo update (nw) 2019-01-28 17:50:38 +11:00
Firehawke
437b7a1c90 Initial implementation of new logo for docs (nw) (#4566)
* Initial implementation of new logo for docs (nw)

Behold the power of SVG!

* 100% gives the same results (nw)
2019-01-28 17:43:37 +11:00
Vas Crabb
995ba92e83 update docs (nw) 2019-01-28 03:59:45 +11:00
algestam
2619be3e18 Doc: Minor fix (nw) (#4547) 2019-01-22 19:09:26 +01:00
Firehawke
ff8cda02cb Correct compilation packages (for #4507) and finish cleanup on previous docs updates. (nw) (#4509)
* Correct the compilation packages [partial for #4507] (nw)

* Minor corrections, joymap adjustments (nw)
2019-01-13 11:18:09 -05:00
Vas Crabb
64c1f2eb5b make INI file loading examples match current behaviour at least (nw) 2019-01-12 05:37:24 +11:00
Vas Crabb
4a6f5ee78f better documentation for compiling on Windows (nw) 2019-01-12 02:23:28 +11:00
Stiletto
a5461d9d6b
2018 -> 2019 changes (nw)
* 2018 -> 2019 changes (nw)
2019-01-10 17:01:26 -05:00
Vas Crabb
4c444b2a00 more command line doc cleanup (nw) 2019-01-11 01:37:17 +11:00
Firehawke
9e3e966dea Major formatting update for command line options, copyright/version update (#4470)
* Update copyrights and docs revision (nw)

Updates copyright on existing 2018 entries to 2019 (and one 2016)
Updates the docs compilation script to MAME 0.205 and 2019 copyright.

* Further formatting overhauling (nw)

Clamp to 80 column where possible; it makes it easier to track errant
line breaks, etc.
Also begin standardizing tab formatting and two spaces after period.

* Further corrections to command line materials (nw)

* More adjustments for Cuavas (nw)

Getting closer to acceptable.
2019-01-11 01:06:52 +11:00
Vas Crabb
cba80b7182 Make informational verbs a bit more consistent, reduce copy/pasted code, a slight performance improvement for reading localisation files, and more documentation clean-up/correction/clarification 2019-01-04 01:12:02 +11:00
Firehawke
6432d66037 Case sensitivity training for INI (nw) (#4455)
* Case sensitivity training for INI (nw)

The world is not 100% Windows, so case sensitvity is needed.

* Further standardization of the formatting (nw)

More to go...

* Pass 2 of new formatting wave (nw)

More to go, though.

* wave 3 of formatting cleanup (nw)

Further adjustments and cleanups, including unwanted tabs.

* Correct filtering instructions (nw)
2019-01-03 04:05:21 +11:00
Vas Crabb
8d40db558e additional documentation on compiling MAME (nw) 2019-01-01 23:30:41 +11:00
Vas Crabb
0374e6f542 (nw) update some documentation and get the MAME and legacy MESS pages more in sync. sorry if I've busted formatting, I can't currently build sphinx or man on this Windows notebook. 2018-12-25 02:57:15 +11:00
Vas Crabb
82501770de srcclean and cleanup (nw) 2018-10-28 14:00:12 +11:00
Firehawke
a2e218f853 Clean up phrasing a bit on input from MG (nw) 2018-10-19 17:02:01 -07:00
Firehawke
ae97f80cb3 Update FAQ (nw) with HLSL/BGFX update info, old external OPL2 support information 2018-10-19 16:47:47 -07:00
Wellington Uemura
62bf710d9d
Fixed broken document structure
* Those chapter numbers are auto generated by sphinx
* Fix the chapters not been bold like the rest of the documentation
* Fix chapter numbers not in sync with the rest of the documentation
* Change the last two chapters to keep up with the document consistency
* Fix bold for nscsi_full_device
2018-10-04 15:42:44 -03:00
Scott Stone
9c0c084d18 Misc. document fixes (nw) 2018-09-26 03:34:20 -04:00
Scott Stone
4861195216 Some more documentation structure fixes (nw) 2018-09-24 15:32:17 -04:00
Scott Stone
91b9f92ddc Misc documentation fixes as brought up by other developers (nw) 2018-09-24 15:20:49 -04:00
Scott Stone
3e94624a08 reference fix (nw) 2018-09-24 14:03:31 -04:00
Scott Stone
fdb070c61d Started commandline documents update to dismiss items no longer in source and start listing recently added commands. More work to come. [Tafoid] 2018-09-24 13:55:18 -04:00
Wellington Uemura
1ab4cac22c
Add missing short commands
I've noticed this while I was translating the manual.
2018-09-13 20:33:40 -03:00
Firehawke
43aa0dbc75 Reword the entire merged set example to avoid long sentence soup (#3857)
* Reword the entire merged set example to avoid long sentence soup, also clarify parent/clone (nw)

* Per request, adjust phrasing slightly more. (nw)
2018-08-17 14:43:01 +10:00
ajrhacker
6d20c2322e
Merge pull request #3843 from felipesanches/wuemura_typo_fix_3805
Fix a typo (found by Wellington Uemura, @katananja) and...
2018-08-09 23:13:26 -04:00
Wellington Uemura
1b47072e49 Fix a typo (found by Wellington Uemura, @katananja) and...
... also replace the '--' by a Harvard comma, as suggested by @cuavas.
(see also: pull request #3805)
2018-08-09 18:49:06 -03:00
Vas Crabb
e0df7a929f finish off layout documentation for now 2018-08-03 16:54:36 +10:00
Vas Crabb
6ea9ff9042 (nw) Further layout work:
* Allow <orientation> and <color> to work on group references
* Fix some corner cases where group bounds could be miscalculated
* Fix a corner case where MAME could incorrectly refuse to instantiate groups
* Add more checks to complay.py
* Document more of the layout format
2018-08-02 23:11:17 +10:00
Vas Crabb
4c0c840f96 (nw) be less eager to shadow variables in layouts, make highlights visible on white squares in modena 2018-07-31 23:54:12 +10:00
Vas Crabb
781d943b36 (nw) more layout documentation 2018-07-31 21:40:20 +10:00
Vas Crabb
0ce07a8a1e (nw) more render work:
* Clean up some corner cases in layouts with repeating blocks
* Make complay.py validate many more elements and attributes
* Make complay.py easier to use for just validating a layout
* Remove redundant view from Sega VMU layout
* Make buttons visually respond to input in whousetc.lay
* Add view with LED displays as well as terminal for aim65_40 and use repeats
* Clean up some outdated "game" terminology in clifront.cpp
* Initiaise a couple of members in tap/tun network module
* Start documenting layout format
2018-07-31 04:18:28 +10:00
Vas Crabb
ccfcb431d0 cherry-pick fixes from mainline and clean up some stuff (nw) 2018-07-23 12:29:25 +10:00
Vas Crabb
6669489679 allow repeating elements and groups - useful if you need e.g. a lot of numbered labels, but it limits complay.py's ability to check for invalid references as it can't evaluate expressions (nw) 2018-07-22 09:52:50 +10:00
Justin Kerk
7809e9005d Better Emscripten parameter handling, & update docs (nw) 2018-07-21 22:05:45 +00:00
Erik Dominikus
34be272b36 Document debugger expression number syntax 2018-03-27 02:06:25 +11:00
Nigel Barnes
ab394331ce Spelling fix in castool documentation (nw) 2018-03-06 13:37:56 +00:00
Vas Crabb
7f6f2a03ff note required Emscripten version (nw) 2018-02-25 18:55:53 +11:00
Vas Crabb
bd473383c8 support multiple patterns and devices in -listfull verb 2018-02-24 03:56:15 +11:00
Stiletto
e51076bd41
(nw)
(nw)
2018-02-07 16:40:50 -05:00
Stiletto
ec5d60720f
Minor updates (nw)
Minor updates (nw)
2018-02-07 16:38:41 -05:00
Firehawke
b2e11d00e0 More docs work: escapes, debugger update (nw) (#3168)
* Missed a couple escape sequences. (nw)

* A little more escaping, acronym fixes, fix oddity in symlist (nw)

* Update debugger internal help to match docs (nw)

* Lowercasing for CPU in command parameters, fix casing on ASCII. (nw)
2018-02-05 20:27:02 +11:00
Firehawke
752cf3d073 Missed a couple escape sequences. (nw) 2018-02-03 19:26:25 +11:00
Firehawke
87cc4b5c4b Terminology cleanup second pass (nw) 2018-02-01 16:58:52 +11:00
Firehawke
010d35fa3f Final pass of verbiage cleanup. (nw) 2018-02-01 16:58:52 +11:00
Firehawke
699de02498 A few corrections for wave 2, more to come. (nw) 2018-02-01 16:58:52 +11:00
Firehawke
7322eeccc3 Terminology update wave 1 (nw) 2018-02-01 16:58:52 +11:00
Firehawke
f481e6b23a Overhaul commandline section of docs, includes index with linkable anchors. (#3112)
* The first set of commandline overhauls. (NW)

* Correct case on headings, further improvements to index, spelling fix

* More updates to the index and cleanup to the commandline stuff. [NW]

* More core options in the index. [NW]

* Finished multiplatform commandline index [NW]

* Completion of first revision commandline index [NW]
2018-01-25 08:37:48 +11:00
Stiletto
feecaac20e
update docs version
update docs version
*nw* just taking care of an annoyance. As far as we know, docs are in sync. If not, it's easily fixed.
2018-01-16 13:56:02 -05:00
Firehawke
88c8b5b0c7 Add additional memory operators per request (NW) (#3067)
* Add additional memory operators per request and further cleanups to expressions (NW)

* Requested adjustments to expressions. (NW)
2018-01-15 15:25:23 +11:00
Firehawke
f2859d0db0 Correct command heading case and adjustments to expressions (NW) 2018-01-15 02:11:15 +11:00
Firehawke
18d3d5ac50 First pass of MAME Debugger help for documentation. (NW) 2018-01-13 21:56:18 -07:00
Nigel Barnes
13b75ab76a Updated documentation for castool and added floptool (nw) 2018-01-11 20:52:49 +00:00
Jonathan Holt
c25b98226d Updates "2017" strings to "2018" where relevant. 2018-01-06 00:48:05 +11:00
Firehawke
52667a4b20 Basic anchor links for FAQ page (#2975) 2017-12-27 14:23:37 -05:00
vadosnaprimer
7e7f2fafd0 rewind implementation fixes and improvements
- reset scheduler savestate to what it was for years before rewind
-- changing saved variables should be done after thorough testing. right now, adding some vars breaks some machines, adding other vars breaks others
- switch to megabyte-wise capacity
-- savestate size greatly differs between machines, relying on state count is unstable
- switch to internal indexing
-- no longer depends on inaccurate machine time
- rewind accelerator key in debugger (Ctrl+F11)
- report capacity hit (once), with some useful info
- make error reports saner
- mention rewind and rewind_capacity in the docs
2017-12-22 04:39:14 +03:00
Stiletto
ded50220ad
(nw) more minor typo fixes for docs.mamedev.org 2017-12-14 00:57:18 -05:00
Firehawke
9ece34eb21 Revert "Revert "Merge branch 'master' of https://github.com/mamedev/mame""
This reverts commit 54155441e9.
2017-12-13 21:31:27 -07:00
Firehawke
54155441e9 Revert "Merge branch 'master' of https://github.com/mamedev/mame"
This reverts commit f537428e5a, reversing
changes made to 0d70d79810.
2017-12-13 21:01:10 -07:00
Stiletto
edb558b916
(nw) more self-service 2017-12-13 15:11:37 -05:00
Stiletto
34ab1202e7
Update whatis.rst
(nw) self-service
2017-12-13 14:26:34 -05:00
AJR
412ef97d71 No more UINT (nw) 2017-12-10 15:32:59 -05:00
AJR
e733af5b08 Documentation update (nw) 2017-12-10 15:32:24 -05:00
Olivier Galibert
6caef2579a dvdisasm: Overhaul [O. Galibert]
Disassemblers are now independant classes.  Not only the code is
cleaner, but unidasm has access to all the cpu cores again.  The
interface to the disassembly method has changed from byte buffers to
objects that give a result to read methods.  This also adds support
for lfsr and/or paged PCs.
2017-11-26 17:41:27 +01:00
hap
2069183658 doc: update MAME short description (nw) 2017-11-05 18:12:28 +01:00
hap
adb7ce7b2e put original abbreviation meaning as trivia here (nw) 2017-11-05 02:01:20 +01:00
hap
7d7c2c5507 make emulator description generic (nw) 2017-11-05 01:50:16 +01:00
Vas Crabb
1e8c0b23c3 This is too contentious, please put it up for review
Revert "Changes to debugger memory address translation"

This reverts commit bb0964f9a2.
2017-08-01 15:19:44 +10:00
AJR
bb0964f9a2 Changes to debugger memory address translation
- memory_translate now returns an address space number rather a boolean flag, permitting addresses in part of one space to map to an entirely different space. This is primarily intended to help MCUs which have blocks of internal memory that can be dynamically remapped, but may also allow for more accurate emulation of MMUs that drive multiple external address spaces, since the old limit of four address spaces per MAME device has been lifted.
- memory_translate has also been made a const method, in spite of a couple of badly behaved CPU cores that can't honestly treat it as one.
- The (read|write)_(byte|word|dword|qword|memory|opcode) accessors have been transferred from debugger_cpu to device_memory_interface, with somewhat modified arguments corresponding to the translate function it calls through to if requested.
2017-08-01 00:21:19 -04:00
Michael.S.G
02cfda6957 Include -output option in documentation
Include -output and it's available options in documentation.
2017-07-05 21:38:39 +10:00
Brian King
834da5a8c1 Updated Fedora instructions
DNF is now preferred package manager. alsa-lib-devel is also required (not mentioned in the current docs)
2017-07-04 12:00:51 -05:00
Olivier Galibert
cbbbd07484 dimemory: Lift the cap on the number of address spaces per device [O. Galibert] 2017-07-03 08:03:57 +02:00
Olivier Galibert
cb1930f6e6 Rename AS_DECRYPTED_OPCODES to AS_OPCODES [O. Galibert] 2017-07-03 08:03:57 +02:00
Stiletto
580898e4ca (nw)
(nw)
2017-06-25 10:34:31 -04:00
Dan Amador
3a43ec44cc Update luaengine.rst 2017-05-22 18:08:28 -05:00
Stiletto
4803de2501 (nw)
(nw)
2017-05-10 14:38:31 -04:00
Stiletto
847e0a1d14 update edit docs link (nw)
update edit docs link (nw)
2017-05-10 10:41:29 -04:00
Prayag Verma
eb7b1f3d20 Fix typos
slighly → slightly
transistion → transition
2017-03-24 23:26:03 +05:30
Stiletto
9db7b63e9a Updates "2016" strings to "2017 where relevant.
Updates "2016" strings to "2017 where relevant.
2017-01-24 17:29:49 -05:00
Vas Crabb
66f1cb5f3a srcclean again (nw) 2016-11-30 07:04:04 +11:00
Olivier Galibert
0136468462 dirom: Document the interface evalution [O. Galibert] 2016-11-28 19:16:39 +01:00
ImJezze
e6580c50a2 Corrected HLSL documentation
- removed -antialias option (does not exist anymore)
- added missing -vector_beam_smooth option
- fixed suggested default values for -bloom_lvl_weights options (were messed up in the last update)
2016-11-14 15:59:15 +01:00
Firehawke
ce943bd45b NW - More documentation updates..
* Fix a few 'mess' references.
* Add important note for -listslots
* FAQ: Wouldn't MAME be faster if X?
2016-10-29 23:32:36 -07:00
Tomer Verona
845b36dae2 Adding id() property to input_device
This change adds id() property to input_device, which represents the
unique device id. This allows the osd layer when creating a device to
pass a friendly display name along with a unique identifier.

Currently the device id is only used to map a physical controller device
to controller id, but can be used more generally in the future. For raw
input devices, we use the full raw input name as the device id. For all
other devices, we fall back to device name as the device id. The
"uniqueness" of the device id is not currently enforced in code.
2016-09-20 12:19:58 -07:00
Tomer Verona
32ea8266a3 A couple of fixes
- Fix null-reference exception when mapping device to unused (null)
controller index
- Restrict device map to controller configs
2016-09-20 01:24:36 -07:00
Tomer Verona
0ed1ce5663 Tweak info message 2016-09-14 17:53:34 -07:00
Tomer Verona
2bd18d5fea Support for configuring device to conrtoller id
This change adds support for configuring device to conrtoller id. This
allows for stable controller ids even if USB devices are plugged /
unplugged, system is rebooted, etc.

See documentation for additional context.
2016-09-12 18:35:36 -07:00
Olivier Galibert
a2c306e923 dimemory, dirom: Add some documentation [O. Galibert] 2016-09-06 12:47:20 +02:00
Firehawke
9d93c07c66 First draft on ROM management for newbies, FAQ entry on common problems with unofficial builds 2016-09-05 00:21:23 -07:00
Miodrag Milanovic
cb30b9d307 Added documentation to main tree (nw) 2016-08-24 15:16:43 +02:00