ChangeSet ID: 1129524515135300513197766 CVSROOT: /cvsroot/wine Module name: docs Changes by: dimi@sc8-pr-cvs1.sourceforge.net 2005/10/16 21:48:35
Modified files: . : README en : winedev-documentation.sgml
Log message: A bit more on how to build the docs. Add a small blurb on how to send patches.
Old revision New revision Changes Path 1.3 1.4 +20 -2 docs/README 1.2 1.3 +8 -7 docs/en/winedev-documentation.sgml
Index: docs/README diff -u -p docs/README:1.3 docs/README:1.4 --- docs/README 17 Oct 2005 4:48:35 -0000 +++ /dev/null 17 Oct 2005 4:48:35 -0000 @@ -24,7 +24,7 @@ $ ./configure; make To build the Wine documentation, you must have: * make (GNU make recommended) * docbook-utils - * openjade/opensp/sp (on Fedora Code/SuSE/Debian) + * openjade/opensp/sp (on Fedora Code/SuSE/Debian respectively) * tetex (for .ps and .pdf output)
4. COMPILATION @@ -45,11 +45,29 @@ $ make <format>
where <format> is one of txt, html, pdf, ps.
-To build only a specific language, run: +To build all formats of a specific language, run:
$ make <lang>
+To build a specific format for a specific language, run: + +$ cd <lang>; make <format> + Currently, we support English (en) and French (fr). +However, French is not built by default due to +bugs in the openjage/opensp/sp packages. + +5. SENDING PATCHES + +Here are the important points you should keep in mind when sending patches: + * submit them to he Wine patches mailing list, wine-patches@winehq.org + * include a ChangeLog entry with a description of the patch + * keep the patch small and the point of the change clear + * one patch per email + * unified format only (diff -u) + +For more information on composing and sending patches, please refer to: + http://www.winehq.org/site/sending_patches
-- Dimi Paun dimi@lattica.com Index: docs/en/winedev-documentation.sgml diff -u -p docs/en/winedev-documentation.sgml:1.2 docs/en/winedev-documentation.sgml:1.3 --- docs/en/winedev-documentation.sgml 17 Oct 2005 4:48:35 -0000 +++ /dev/null 17 Oct 2005 4:48:35 -0000 @@ -635,15 +635,11 @@ </para></listitem>
<listItem><para> - Switch to your toplevel Wine directory + Switch to your toplevel wine-docs directory </para></listitem>
<listItem><para> - Run <command>./configure</command> (or <command>make distclean && ./configure</command>) - </para></listitem> - - <listItem><para> - Switch to the <filename>documentation/</filename> directory + Run <command>./configure</command> </para></listitem>
<listItem><para> @@ -651,11 +647,16 @@ </para></listitem>
<listItem><para> - View <filename>wineusr-guide.html</filename>, <filename>winedev-guide.html</filename>, etc. in your favorite browser + View <filename>en/wineusr-guide.html</filename>, <filename>en/winedev-guide.html</filename>, etc. in your favorite browser </para></listitem>
</orderedlist>
+ <para> + For more information on building the documentation, please see the <filename>README</filename> file + at the toplevel wine-docs directory. + </para> + </sect3>
<sect3>