[Kos-cvs] kos/doc Makefile, 1.26, 1.27 modules.tex, 1.27, 1.28 testingfr.tex, 1.15, 1.16

Wed Dec 29 20:03:41 CET 2004

Update of /home/kos/cvs/kos/doc
In directory the-doors:/tmp/cvs-serv736/doc

Modified Files:
	Makefile modules.tex testingfr.tex 
Log Message:
2004-12-29  Thomas Petazzoni  <thomas at crazy.kos.nx>

	* doc/Makefile: Make sure the doxygen-generated documentation is
	cleaned during 'make clean'.

	* doc/testingfr.tex: Documentation update to include informations
	about network adapter emulation with Bochs and Qemu.

	* doc/modules.tex: Documentation update to include informations
	about EXPORT_FUNCTION_RESTRICTED.



Index: modules.tex
===================================================================
RCS file: /home/kos/cvs/kos/doc/modules.tex,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -d -r1.27 -r1.28

--- modules.tex	8 Jul 2002 19:22:35 -0000	1.27
+++ modules.tex	29 Dec 2004 19:03:39 -0000	1.28
@@ -3,6 +3,8 @@
 \usepackage[frenchb]{babel}
 \usepackage[latin1]{inputenc}
 \usepackage{graphicx}
+\usepackage{palatino}
+\usepackage{a4wide}
 
 \usepackage[dvips,
     pdftitle={KOS modules},
@@ -23,10 +25,10 @@
                                   %% sur kos.enix.org (pb latex)
 
 \title{Les modules \href{http://kos.enix.org}{\kos}}
-\author{Julien Munier\footnote{\mailto{munier at wanadoo.fr}},
-        Thomas Petazzoni\footnote{\mailto{thomas.petazzoni at ifrance.com}}
-        et David Decotigny\footnote{\mailto{david.decotigny at irisa.fr}}}
-\date{15 Octobre 2000\\ Mise à jour : 8 Juillet 2002}
+\author{Julien Munier\footnote{\mailto{mejj at enix.org}},
+        Thomas Petazzoni\footnote{\mailto{thomas.petazzoni at enix.org}}
+        et David Decotigny\footnote{\mailto{d2 at enix.org}}}
+\date{15 Octobre 2000\\ Mise à jour : 29 Décembre 2004}
 
 \newcommand{\kos}{{\sc Kos}}
 \newcommand{\loader}{{\sc Kos loader}}
@@ -244,6 +246,12 @@
   \texttt{sym} doit \^etre d\'efini au pr\'ealable (soit dans un
   header, soit avant dans le m\^eme fichier source)~. Attention :
   \texttt{sym} ne peut être lui-même être une autre macro !
+\item[]\texttt{EXPORT\_FUNCTION\_RESTRICTED(sym, module)}~: Cette
+  macro a le même effet que la précédente sauf que le symbole exporté
+  ne sera visible que depuis le module spécifié en second argument. Le
+  nom du module à donner est le nom du fichier du module comme il est
+  reçu par le \loader, sans son extension. Par exemple : {\tt task},
+  {\tt arch\_mm} ou {\tt sched}.
 \item[]\texttt{DECLARE\_INIT\_SYMBOL(sym,level)}~: La fonction
 \texttt{sym} sera une fonction d'initialisation du module de niveau
 {\tt level}. Plusieurs fonctions d'initialisation peuvent être

Index: Makefile
===================================================================
RCS file: /home/kos/cvs/kos/doc/Makefile,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -d -r1.26 -r1.27
--- Makefile	4 Jun 2002 17:59:23 -0000	1.26
+++ Makefile	29 Dec 2004 19:03:39 -0000	1.27
@@ -19,7 +19,7 @@
 vm_manag.dvi: mem_map.eps
 modules.dvi: module.eps
 
-DEP_CLEAN=html-clean
+DEP_CLEAN=html-clean doxygen-clean
 
 TOPSRCDIR :=..
 include $(TOPSRCDIR)/MkRules
@@ -83,3 +83,6 @@
    $(addprefix ./k/,$(clean_wildcards))
 html-clean:
 	$(RM) -r $(SRCS:%.tex=%-html)
+
+doxygen-clean:
+	$(RM) -r src-html-doc src-latex-doc

Index: testingfr.tex
===================================================================
RCS file: /home/kos/cvs/kos/doc/testingfr.tex,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- testingfr.tex	28 Dec 2004 18:44:11 -0000	1.15
+++ testingfr.tex	29 Dec 2004 19:03:39 -0000	1.16
@@ -661,6 +661,48 @@
 \end{enumerate}
 
 \appendix
+
+\section{Support réseau dans les émulateurs}
+
+\subsection{Dans Bochs}
+
+Pour avoir le support réseau dans Bochs avec une carte PCI, il faut
+compiler Bochs avec les options de configuration {\tt --enable-pci} et
+{\tt --enable-ne2000}.
+
+Ensuite dans le fichier de configuration {\tt .bochsrc}, il faut
+ajouter :
+
+\begin{verbatim}
+ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=null, ethdev=eth0
+i440fxsupport: enabled=1, slot2=ne2k
+\end{verbatim}
+
+La première ligne indique à Bochs d'activer une carte réseau. Par
+défaut, elle est simplement ISA, sauf si la configuration PCI est
+activée. La méthode de liaison utilisée ici est {\em null}, ce qui
+signifie que les paquets réseau n'iront nulle part. C'est la
+configuration à utiliser si l'on souhaite tester la détection de la
+carte, mais pour une utilisation réelle, on préfèrera utiliser les
+méthodes {\em tap} ou {\em tuntap} par exemple.
+
+La seconde ligne indique d'activer le PCI. La partie {\tt slot2=ne2k}
+est particulièrement importante : Bochs n'alloue pas dynamiquement les
+slots pour les périphériques PCI. Si on ne précise pas dans quel slot
+doit être mis tel périphérique PCI, alors Bochs ne gerera pas le PCI
+pour ce périphérique.
+
+\subsection{Dans Qemu}
+
+Rien de spécial n'est à effectuer au niveau de Qemu pour qu'une carte
+réseau soit activée. Toutefois, si l'on ne spécifie rien à Qemu, il
+tente d'éxécuter le script {\tt /etc/qemu-ifup} qui effectue un sudo.
+
+Pour un fonctionnement simple servant juste à vérifier si la détection
+de la carte réseau fonctionne, on pourra utiliser l'option {\tt
+  -dummy-net}. Si l'on souhaite réellement utiliser le réseau, il
+faudra alors se reporter à l'option {\tt -n} de {\em Qemu}.
+
 \section{Compilation sous Windows}
 
 La compilation sous Windows n'a pas été testée depuis un long
@@ -669,6 +711,12 @@
 ce système. Cependant, si vous essayez la compilation, n'hésitez pas à
 nous faire part des problèmes rencontrés.
 
+{\bf Attention:} À l'heure actuelle, \kos ne compile pas avec Cygwin,
+en raison d'un conflit sur la définition du type {\tt addr\_t}. Un
+patch a été écrit pour résoudre ce problème, mais n'est pas encore
+intégré au CVS. N'hésitez pas à demander des renseignements
+complémentaires.
+
 \subsection{Prérequis}
 
 Il est théoriquement possible de compiler \kos sous Windows, mais pour
@@ -756,10 +804,4 @@
 alors celle-ci est prête pour être bootée dans un émulateur, Bochs ou
 VMWare par exemple.
 
-{\bf Attention:} À l'heure actuelle, \kos ne compile pas avec Cygwin,
-en raison d'un conflit sur la définition du type {\tt addr\_t}. Un
-patch a été écrit pour résoudre ce problème, mais n'est pas encore
-intégré au CVS. N'hésitez pas à demander des renseignements
-complémentaires.
-
 \end{document}

