mirrors/Bochs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- removed obsolete file codingguidelines.html

Browse Source 
- updated docs-html/index.html and fixed links to new docs
- improved coding guidelines (LGPL compatibility)
This commit is contained in:
Volker Ruppert 2006-01-21 12:51:54 +00:00
parent 90b38ba96f
commit d8c3336047
3 changed files with 5 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
bochs/doc/docbook/development/development.dbk
View File

@ -1,7 +1,7 @@
<!--
================================================================
doc/docbook/development/development.dbk
$Id: development.dbk,v 1.20 2006-01-19 21:17:45 vruppert Exp $
$Id: development.dbk,v 1.21 2006-01-21 12:51:54 vruppert Exp $
This is the top level file for the Bochs Developers Manual.
================================================================
@ -1948,6 +1948,7 @@ There is no uniform way to handle tabs properly.</para></listitem>
<para>It's really difficult to spot interesting warnings when a compile is littered
with non-interesting ones.</para></listitem>
<listitem><para><command>Don't use signed ints where unsigned will do.</command></para></listitem>
<listitem><para><command>Make sure that contributed code / patches are LGPL compatible.</command></para></listitem>
</itemizedlist>
</para>
</section>

49
bochs/docs-html/codingguidelines.html
View File

@ -1,49 +0,0 @@
<html>
<head>
<META NAME="copyright" CONTENT="Copyright 2001 by MandrakeSoft S.A.">
<META NAME="Author" CONTENT="Kevin Lawton">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=iso-8859-1">
<TITLE>Coding Guidelines For Bochs</TITLE>
</head>
<body TEXT="#000000" BGCOLOR="#ececec" LINK="#3333cc" VLINK="#666666">
<center><h1>Coding Guidelines For Bochs</h1></center>
<br>
<ul>
<li> <u>Don't make use of any external C++ classes.</u> &nbsp;They are not offered
on all platforms and this would make bochs non-portable. &nbsp;There is use of
such classes in the optional debugger. &nbsp;I plan on removing this use.
<li> <u>Don't use fancy C++ features.</u> &nbsp;Bochs is incredibly
performance sensitive, and will be increasingly so as more speed
enhancements are added. &nbsp;There's a time and place for most
everything and this is not it. &nbsp;Some advanced features
create overhead in the generated code that you don't see.
They also convolute the code, and sometimes occlude
what is really going on.
<ul>
<li> Don't use templates.
<li> Don't use virtual functions.
<li> Don't use C++ exceptions.
<li> Don't use overloading of any kind.
</ul>
<li> <u>Use soft tabs.</u> At least when you submit code, convert all
hard tabs to spaces. There is no uniform way to handle
tabs properly.
<li> <u>Prefix screen spew with a pound sign ('#').</u>
If you want to spew something out to the screen rather than
the bochs.out file, send it to stderr (not stdout), and prefix the string
with a pound sign. This is so that a text interface which
drives bochs (the debugger) can discern between messages and
command responses.
<li> <u>Please do compile with all warnings turned on.</u> &nbsp;It's really
difficult to spot interesting warnings when a compile is littered
with non-interesting ones.
<li> <u>Don't use signed ints where unsigned will do.</u>
</ul>
</body>
</html>

7
bochs/docs-html/index.html
View File

@ -22,16 +22,15 @@ format. This page shows the "old documentation" which was written in
HTML. The old documtation will be replaced as soon as all of the content
is converted into Docbook. Please check the new documentation first, since it
is more current:<br><br>
<a href="http://bochs.sf.net/doc/docbook/user/book1.html">User Guide</a><br>
<a href="http://bochs.sf.net/doc/docbook/development/book1.html">Development Guide</a><br>
<a href="http://bochs.sf.net/doc/docbook/documentation/book1.html">Documentation Guide</a><br>
<a href="http://bochs.sf.net/doc/docbook/user/index.html">User Guide</a><br>
<a href="http://bochs.sf.net/doc/docbook/development/index.html">Development Guide</a><br>
<a href="http://bochs.sf.net/doc/docbook/documentation/index.html">Documentation Guide</a><br>
</td></tr>
</table>
<br><A TARGET="_top" HREF="http://bochs.sourceforge.net/">Bochs Home Page</A>
<br><A HREF="cosimulation.html">Cosimulation</A>
<br><A HREF="iodebug.html">I/O Interface to Bochs Debugger</A>
<br><A HREF="codingguidelines.html">Coding Guidelines</A>
<br><A HREF="Linux.html">Installation instructions for Linux</A>
</center>