[Lseos-devel] [LSEOS] documentation behavior and directories structure

[<dh...@gm...>]

Hi everybody,
One thing which is presently missing in the lseos is
the documentation.
I think it could be a good idea to begin now the production
of the documentation.
From my point of view, we should use doxygen in our .h files
with at least @desc @param @return and the @see would point on
globals or functions used by the function=20
For the rest, I think we should do the same as Linux : in the lseos-doc,
every module, functionnality of the kernel must be described. It's not
a mandatory
to have a very technical description but it would be sufficient for a
newbie to understand
how he could use the functionnality (nobody should have to take a look
to the sources).

There's another thing with the lseos kernel build scripts.
We currently ooking for a cleaner solution to build only the kernel,
the lseos-unix part of the source tree is deprecated since the glibc is goi=
ng to
be ported in order to have the gnu tools on the os.

The last thing is about the source tree structure.
The current is good but could be better.
I propose you to put the .h files in a subdirectory named include :)
and to create in every module, or functionnality as you want directory
another subdir named man to put the man pages related to the dirctory
(the module or functionnality).
The man pages are not mandatory and therefore the man dir isn't too.

we will have a structure like this=20

lseos
  lseos-core
    kernel
       include
       man
   lseos-srv
      tty
       serial
          include
          man
       net
        ....

it's my point of view, just say me what you think about it so we can
discuss efficiently ;)

have a nice day


--=20
R=E9my Saissy

--=20
R=E9my Saissy