nesdev.com
http://forums.nesdev.com/

Wiki PPU register formatting
http://forums.nesdev.com/viewtopic.php?f=16&t=12382
Page 1 of 2

Author:  koitsu [ Sat Feb 14, 2015 2:50 pm ]
Post subject:  Wiki PPU register formatting

I'd like to ask for folks' opinion of having the PPU registers "table-ised". I recently saw this formatting being used in the APU Frame Counter page and found it a lot easier to understand/visualise, plus it's a bit more compact.

Proposed new: http://wiki.nesdev.com/w/index.php/User ... _.3E_write
Old: http://wiki.nesdev.com/w/index.php/User ... 3E_write_2

I don't want to change anything unless the majority of folks like the change. I can make this into a poll if that'd be preferred.

Author:  tepples [ Sat Feb 14, 2015 3:03 pm ]
Post subject:  Re: Wiki PPU register formatting

My old style was an imitation of Firebug's mapper document, for what it's worth.

Author:  koitsu [ Sat Feb 14, 2015 3:11 pm ]
Post subject:  Re: Wiki PPU register formatting

*nod* It's fine tepples, it's just that we should be consistent with our register formatting.

I happen to like the table-ised version more -- but as I got bit by the syntax highlighter incident, I'm not going to spend the time mass-modifying things only to have to revert it all later, so I'm asking in advance. :-)

Author:  snarfblam [ Sat Feb 14, 2015 3:34 pm ]
Post subject:  Re: Wiki PPU register formatting

I personally prefer preformatted text. It copies and pastes easier and it's easier to edit. I'm not a fan of the lines drawn using pipes, plus signs, and dashes, but I find something like this both easier to read and easier to work with.
Code:
Bit     Function
---     ----------
0/1     Base nametable address
            (0 = $2000; 1 = $2400; 2 = $2800; 3 = $2C00)
2       VRAM address increment per CPU read/write of PPUDATA
            (0: add 1, going across; 1: add 32, going down)
3       Sprite pattern table address for 8x8 sprites
            (0: $0000; 1: $1000; ignored in 8x16 mode)
4       Background pattern table address (0: $0000; 1: $1000)
5       Sprite size (0: 8x8; 1: 8x16)
6       PPU master/slave select
            (0: read backdrop from EXT pins; 1: output color on EXT pins)
7       Generate an NMI at the start of the vertical blanking interval (0: off; 1: on)

Or something like this.

Author:  koitsu [ Sat Feb 14, 2015 3:37 pm ]
Post subject:  Re: Wiki PPU register formatting

Can I ask why you'd be copy-pasting stuff from the wiki to begin with? This sounds like an edge use case for something uncommon.

Also, bits are usually defined/documented in order of MSB to LSB (i.e. bit 7, bit 6, bit 5... bit 0). That's a pretty much "universal norm" in technical documentation. It all stems from most things being done left-to-right, and because of how "bit math" works (%00 = 0, %01 = 1, %10 = 2, %11 = 3, etc.) -- reversing that order isn't how computers work. Maybe Hebrew documentation is different? Dunno.

Author:  tepples [ Sat Feb 14, 2015 3:51 pm ]
Post subject:  Re: Wiki PPU register formatting

I don't know either. Was the UART, which transmits LSB first, invented by Hebrew speakers? Were Hebrew speakers behind USB, which also transmits LSB first?

Author:  lidnariq [ Sat Feb 14, 2015 3:52 pm ]
Post subject:  Re: Wiki PPU register formatting

snarfblam wrote:
preformatted text [... is] easier to edit
Wat?

My personal favorite layout is Microchip's documentation of internal registers. But it's optimized for print, not a wiki, so I'm not certain how applicable it is.

Author:  snarfblam [ Sat Feb 14, 2015 3:53 pm ]
Post subject:  Re: Wiki PPU register formatting

koitsu wrote:
Can I ask why you'd be copy-pasting stuff from the wiki to begin with? This sounds like an edge use case for something uncommon.

Doesn't have to be the primary consideration, just a bonus with preformatted text. I'm also not particularly concerned about whether bits are listed greatest to least of vice-verse. That's not the point I was getting at.

lidnariq wrote:
Wat?

Text editor? Simple to use? No?

Author:  lidnariq [ Sat Feb 14, 2015 4:00 pm ]
Post subject:  Re: Wiki PPU register formatting

tepples wrote:
I don't know. Was the UART, which transmits LSB first, invented by Hebrew speakers? Were Hebrew speakers behind USB, which also transmits LSB first?
Was x86 invented by hebrew speakers? How about VAX? What a ludicrous strawman. There are technical reasons for serial protocols to be little endian ... or big endian ... and that has nothing to do with the printed representation.

Author:  tepples [ Sat Feb 14, 2015 4:11 pm ]
Post subject:  Re: Wiki PPU register formatting

Image
If I only had a brain...


I guess the choice of explaining LSB first or explaining MSB first could depend on whether the LSB value controls the interpretation of MSB or the MSB value controls the interpretation of LSB.

Author:  koitsu [ Sat Feb 14, 2015 5:07 pm ]
Post subject:  Re: Wiki PPU register formatting

Okay so now that the thread has gotten completely off-topic in the matter of like an hour, can we please re-focus on what I originally asked? :P All I've got so far is one person saying they'd prefer the preformatted/plaintext version.

Author:  thefox [ Sat Feb 14, 2015 5:22 pm ]
Post subject:  Re: Wiki PPU register formatting

I prefer the proposed new format.

EDIT: I guess I'll add a short description about "why": It's easier to connect a description to the corresponding bit (the bit number and its mask) in a single glance. YMMV.

Author:  tepples [ Sat Feb 14, 2015 5:22 pm ]
Post subject:  Re: Wiki PPU register formatting

I just asked in #nesdev on EFnet, and Lord_Nigh told me he prefers "Old"
http://git.redump.net/mame/tree/src/mess/drivers/cat.c
Scroll down around lines 717, 784, 843, 862

EDIT: More from #nesdev

<Movax21> I think the first is slightly easier to read. I don't hate the old one, but I think the new one is slightly better.
<Ulfalizer> i think i like the old one better. less spammy. might just be that i'm more used to it though. less line-following anyway

Author:  rainwarrior [ Sat Feb 14, 2015 10:35 pm ]
Post subject:  Re: Wiki PPU register formatting

I prefer the old way, but mostly just because it's more consistent with most of the mapper pages. Frame counter is an oddball.

I do like labelling the various bits with letters though. Consider an alternative that's used on a lot of the mapper pages: http://wiki.nesdev.com/w/index.php/VRC6_audio

What I dislike most about the tables is all the lines between rows, and I just find the labelling of the rows a bit ugly, I suppose.


I think the PPU registers page could use a summary table like the main APU page. Maybe I'll add one now...

Author:  lidnariq [ Sat Feb 14, 2015 11:25 pm ]
Post subject:  Re: Wiki PPU register formatting

I slightly prefer the new way, but I don't care much.

Since I had vouched for the "microchip style", I've mocked something up on the wiki. Caveat: I don't think it's a good match, because (among other things) it's big, it requires coming up with a name for every single bit, and large portions are redundant on the NES in ways that they aren't on PICs.

Page 1 of 2 All times are UTC - 7 hours
Powered by phpBB® Forum Software © phpBB Group
http://www.phpbb.com/