Re: *TODO* Document the pseudo-ops (adr, ops)

[Russell King - ARM Linux Admin]

S A McConnell writes:
> > There are some tricky things to watch out for, such as the pc always
> > being 8 bytes ahead of the current instruction, and manipulating the
> > caches and MMU, the details of which are left for the reader to
> > discover :)

The above is all covered in both the ARM architecture reference manual and
the individual processor technical reference manuals.

> I would love to see some documentation about the MMU setup for the ARM
> and how the tables are constructed. Since I started looking at the
> kernel in January I have been wondering why there is no documentation.

Again, the structure of the MMU tables is described in the ARM architecture
reference manual and the individual processor TRMs - there are some parts of
the tables which are processor implementation specific.

The various bits where the tables are initialised are commented.  The
initial setup code that allows the kernel to get going is very well self-
documented.  Looking at the other code, it also seems to have adequate
comments for what the code is doing.

Please note that the kernel sources are not supposed to contain reference
information, but are supposed to contain enough for a programmer to
understand what the code is doing.  The general guidance given here is that
the code should be written such that it is understandable, and with comments
that do not describe what every line of code does, but describes the purpose
behind what the code is doing.

I hope this helps.
   _____
  |_____| ------------------------------------------------- ---+---+-
  |   |        Russell King       [EMAIL PROTECTED]      --- ---
  | | | |            http://www.arm.linux.org.uk/            /  /  |
  | +-+-+                                                     --- -+-
  /   |               THE developer of ARM Linux              |+| /|\
 /  | | |                                                     ---  |
    +-+-+ -------------------------------------------------  /\\\  |

unsubscribe: body of `unsubscribe linux-arm' to [EMAIL PROTECTED]
++        Please use [EMAIL PROTECTED] for           ++
++                        kernel-related discussions.                      ++