docs May 2005

docs@lists.fedoraproject.org

24 participants
32 discussions

how to generate a pot file for FC-4 release-notes? thx.
by Yuan Yijun 31 May '05

31 May '05

Greetings, I have checked out the release-notes of FC-4 from cvs. Some one suggests me to use xml2po to simplify the translation process. I tried it but it doesn't work. Some xml files are blank, without a root element. Only one of them contains DOCTYPE and xml2po just ignores all the tags in the other files. If I specify *.xml in the command line, xml2po prompts me Traceback (most recent call last): File "/usr/bin/xml2po", line 716, in ? CurrentXmlMode.preProcessXml(doc,msg) File "/usr/share/xml2po/docbook.py", line 142, in preProcessXml root = doc.getRootElement() File "/usr/lib/python2.4/site-packages/libxml2.py", line 4064, in getRootElement if ret is None:raise treeError('xmlDocGetRootElement() failed') libxml2.treeError: xmlDocGetRootElement() failed What should I do to generate a proper pot file? BTW, are there any chinese speakers on this list? -- bbbush ^_^

3 3

Re: release-notes/FC4 kernel.xml,1.3,1.4
by Karsten Wade 31 May '05

31 May '05

I suppose since these are commented out they don't affect anything except ... well, I can't figure what. I'm soooo curious, how do they make editing easier? Is it to keep track of the entities used? BTW, I think your <screen> style is off from the style guidelines ... http://fedora.redhat.com/participate/documentation-guide/s1-xml-tags-screen… Some of your check-ins have funky indenting ... the <para> content is two characters from the left. We all seem to have subtle differences. Not sure how to resolve that. When I get a chance, I'm going to first reformat kernel.xml, then commit, then edit the content, all to make for a saner, happier diff. This worked great, btw. Everyone formed like Voltron, really brought a lot of good content and shine to the relnotes. - Karsten On Mon, 2005-05-30 at 19:27 -0400, Tommy Reynolds wrote: > + > + > +<section id="sn-kernel"> > + <title> > + Linux Kernel > + </title> > + <section id="sn-kernel-lotsa"> > + <title>Version</title> > + <para> > + The &DISTRO; is based on a 2.6.11 kernel. > + &FC; may include additional patches for improvements, bug fixes, or additional features. > + For this reason, the &FC; kernel may not be line-for-line equivalent to the so-called vanilla kernel from the <ulink url="http://ww.kernel.org"><filename>kernel.org</filename></ulink> web site. > + </para> > + <para> > + You may obtain a list of any such patches by using the command on the &FC; package: > + </para> > + <screen width="56"><prompt>$ </prompt><command>rpm</command> <parameter class="option">-qpl</parameter> <filename>kernel-</filename><replaceable><version></replaceable><filename>.src.rpm</filename></screen> > + </section> > + <section id="sn-kernel-flavors"> > + <title>Kernel Flavors</title> > + <para> > + &FC; includes the following kernel builds: > + </para> > + <itemizedlist> > + <listitem> > + <para> > + Native kernel, in both uniprocessor and <abbrev>SMP</abbrev> varieties. > + </para> > + <para> > + Configured sources are available in the <filename>kernel-devel-</filename><replaceable><version></replaceable><filename>.</filename><replaceable><arch></replaceable><filename>.rpm</filename> package. > + </para> > + </listitem> > + <listitem> > + <para> > + Virtual kernel for use with the <wordasword>XEN</wordasword> emulator package. > + </para> > + <para> > + Configured sources are available in the <filename>kernel-xen0-devel-</filename><replaceable><version></replaceable><filename>.</filename><replaceable><arch></replaceable><filename>.rpm</filename> package. > + </para> > + </listitem> > + </itemizedlist> > + <para> > + Sources for both kernel flavors may be installed at the same time. > + The files will be installed into the <filename>/usr/src/kernels/</filename><replaceable><version></replaceable>[<filename>-xen0</filename>]<filename>-</filename><replaceable><arch></replaceable><filename>/</filename> tree. > + Use the command: > + </para> > + <screen width="56"><prompt># </prompt><command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-devel[-xen0]-</filename><replaceable><version></replaceable><filename>.</filename><replaceable><arch></replaceable><filename>.rpm</filename></screen> > + <para> > + as appropriate. > + </para> > + <tip> > + <title>Following Generic Textbooks</title> > + <para> > + Many of the tutorials, examples, and textbooks about Linux kernel development assume the kernel sources are installed under the <filename>/usr/src/linux</filename> directory. > + If you make a symbolic link, as shown below, you should be able to use those learning materials with the &FC; packages. > + Install the appropriate kernel sources, as shown earlier, and then: > + </para> > + <screen width="56"><prompt># </prompt><command>ln</command> <parameter class="option">-s</parameter> <filename>/usr/src/kernels/kernel-</filename><replaceable><all-the-rest></replaceable> <filename>/usr/src/linux</filename></screen> > + </tip> > + </section> > +  > + <section id="sn-kernel-exploding"> > + <title> > + Preparing for Kernel Development > + </title> > + <para> > + &DISTRO; &DISTROVER; does not include the <filename>kernel-source</filename> package provided by older versions. > + Instead, configured sources are available as described in <xref linkend="sn-kernel-flavors"/>. > + Users that require access to &FC; original kernel sources can find them in the <filename>kernel</filename> <filename>.src.rpm</filename> package. > + To create an exploded source tree from this file, perform the following steps: > </para> > - <tip> > - <title>Source not required to build kernel modules</title> > + <warning> > + <title>These Instructions Refer The Currently-running Kernel!</title> > + <para> > + To simplify the following directions, we have assumed that you want to configure the kernel sources to match your currently-running kernel. > + In the steps below, you must understand that the phrase <wordasword><version></wordasword> refers to the kernel version shown by the: > + </para> > + <screen width="56"><prompt>$ </prompt><command>uname</command> <parameter class="option">-r</parameter></screen> > + <para> > + command. > + </para> > + </warning> > + <procedure id="sn-kernel-exploding-steps"> > + <step> > + <para> > + Obtain the <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename> file from one of the following sources: > + </para> > + <itemizedlist> > + <listitem> > + <para> > + The <filename>SRPMS</filename> directory on the appropriate <wordasword>SRPMS</wordasword> <abbrev>CD</abbrev> <filename>iso</filename> image. > + </para> > + </listitem> > + <listitem> > + <para> > + The FTP site where you got the kernel package. > + </para> > + </listitem> > + <listitem> > + <para> > + By running the following command: > + </para> > + <screen width="56"><prompt># </prompt><command>up2date</command> <parameter class="option">--get-source</parameter> <filename>kernel</filename></screen> > + </listitem> > + </itemizedlist> > + </step> > + <step> > + <para> > + Install <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename> using the command: > + </para> > + <screen width="56"><prompt># </prompt><command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-</filename><replaceable><version></replaceable><filename>.src.rpm</filename></screen> > + <para> > + This writes the <abbrev>RPM</abbrev> contents into <filename>/usr/src/redhat/SOURCES</filename> and <filename>/usr/src/redhat/SPECS</filename>. > + </para> > + </step> > + <step> > + <para> > + Prepare the kernel sources using the commands: > + </para> > + <screen width="56"><prompt># </prompt><command>cd</command> <filename>/usr/src/redhat/SPECS</filename> > +<prompt># </prompt><command>rpmbuild</command> <parameter class="option">-bp --target $(arch)</parameter> <filename>kernel.spec</filename></screen> > + <para> > + The kernel source tree will be located in the <filename>/usr/src/redhat/BUILD/kernel-</filename><replaceable><version></replaceable> directory. > + It is common practice to move the resulting <filename>linux-</filename><replaceable><version></replaceable> directory to the <filename>/usr/src</filename> tree; while not strictly necessary, we suggest that you do this to match the generally-available documentation. > + </para> > + <screen width="56"><prompt># </prompt><command>cd</command> <filename>/usr/src/redhat/BUILD/kernel-</filename><replaceable><version></replaceable> <filename>/usr/src/</filename> > +<prompt># </prompt><command>mv</command> <filename>linux-</filename><replaceable><version></replaceable> <filename>/usr/src/</filename> > +<prompt># </prompt><command>cd</command> <filename>/usr/src</filename> > +<prompt># </prompt><command>ln</command> <parameter class="option">-s</parameter> <filename>./linux-</filename><replaceable><version></replaceable> <filename>linux</filename> > +<prompt># </prompt><command>cd</command> <filename>/usr/src/linux</filename></screen> > + </step> > + <step> > + <para> > + The configurations for the specific kernels shipped in &DISTRO; &DISTROVER; are in the <filename>configs/</filename> directory. > + For example, the i686 SMP configuration file is named <filename>configs/kernel-<replaceable><version></replaceable>-i686-smp.config</filename>. > + Issue the following command to place the desired configuration file in the proper place for building: > + </para> > + <screen width="56"><prompt># </prompt><command>cp</command> <filename>configs/</filename><replaceable><desired-config-file></replaceable> <filename>.config</filename></screen> > + </step> > + <step> > + <para> > + Issue the following command: > + </para> > + <screen width="56"><prompt># </prompt><command>make oldconfig</command></screen> > + </step> > + </procedure> > + <para> > + You can then proceed as usual. > + </para> > + </section> > + <section id="sn-kernel-3rdparty"> > + <title>Building Only Kernel Modules</title> > <para> > - An exploded source tree is <emphasis>not</emphasis> required to > - build kernel modules against the currently in-use kernel. > + An exploded source tree is <emphasis>not</emphasis> required to build a kernel module, such as your own device driver, against the currently in-use kernel. > </para> > <para> > - For example, to build the <filename>foo.ko</filename> module, > - create the following file (named <filename>Makefile</filename>) in > - the directory containing the <filename>foo.c</filename> file: > + For example, to build the <filename>foo.ko</filename> module, create the following <filename>Makefile</filename> in the directory containing the <filename>foo.c</filename> file: > </para> > -<screen> > -<computeroutput> > -obj-m := foo.o > +<programlisting width="56"> > +obj-m := foo.o > > -KDIR := /lib/modules/$(shell uname -r)/build > -PWD := $(shell pwd) > +KDIR := /lib/modules/$(shell uname -r)/build > +PWD := $(shell pwd) > > default: > - $(MAKE) -C $(KDIR) SUBDIRS=$(PWD) modules > -</computeroutput> > -</screen> > - <para> > + $(MAKE) -C $(KDIR) M=$(PWD) modules > +</programlisting> > + <para> > Issue the <command>make</command> command to build the > <filename>foo.ko</filename> module. > </para> > - </tip> > + </section> > + <section id="sn-kernel-coop"> > + <title>Userspace Dependancies on the Kernel</title> > + <para> > + &DISTRO; adds support for clustered systems. > + This requires a special kernel that works in conjunction with some user-space utilities, such as management daemons. > + Consequently, to remove such a kernel, perhaps after an update, you <emphasis>cannot</emphasis> simply use the <command>rpm -e kernel-</command><replaceable><version></replaceable> command as in earlier distributions because these userspace packages depend on the kernel package. > + You may either list both the kernel package and its userspace dependant packages on the <command>rpm -e</command> command, or you may wish to use the <command>yum remove kernel-</command><replaceable><version></replaceable> command instead since <command>yum</command> automatically removes dependant packages if necesssary. > + </para> > + </section> > </section> > <!-- > Local variables: > > -- > Fedora-docs-commits mailing list > Fedora-docs-commits(a)redhat.com > https://www.redhat.com/mailman/listinfo/fedora-docs-commits -- Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/ gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41 Red Hat SELinux Guide http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/

2 1

for writing relnotes beats
by Karsten Wade 26 May '05

26 May '05

If you are writing a relnotes beat, you can write directly into the XML in CVS. The files in release-notes/FC4/ are mainly ready to go. I still have to include all of the information from FC4 tests, the current content in those XML files is for FC3 (the source I used). Feel free to include the test changes yourself that are in release-notes/fc4- relnotes. - Karsten -- Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/ gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41 Red Hat SELinux Guide http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/

1 1

call for release notes for FC4
by Karsten Wade 26 May '05

26 May '05

Now is your final time to get your release note requests in for Fedora Core 4. Current version of the release notes is available here: http://fedora.redhat.com/docs/beta/release-notes-en/fc4-relnotes This version is in plain text. Here is how you can send in release notes: * Use this pre-filled bugzilla template (preferred method): http://tinyurl.com/exov3 -- OR -- * Send email with details to relnotes(a)fedoraproject.org . The latter will likely have a bug created to track discussion and resolution. Please file a bug instead in the first place. Release notes are now being handled by a team through the Fedora Documentation Project. Individuals or small groups handle a particular relnotes beat. Your note will be assigned to a writer on your beat. All release note requests are available through the tracking bugzilla number: https://bugzilla.redhat.com/beta/showdependencytree.cgi?id=151189 You can read more about the beats, which are subject to change as we develop this process. Note that many of the current writers are temporary assignments only. http://fedoraproject.org/wiki/DocsProject/ReleaseNotes/Beats We are looking for ongoing relnotes beat writers. If you or anyone else is interested, please visit: http://www.fedoraproject.org/wiki/DocsProject/NewWriters Thanks - Karsten -- Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/ gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41 Red Hat SELinux Guide http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/

2 3

OpenOffice.org 1.9 (FC4t3)
by Paul W. Frields 26 May '05

26 May '05

FWIW, I have been playing a little bit with the FC4test3 build, and as of last night, OO.o now will create DocBook XML 4.1.2 documents "out of the box," as long as the Java environment is installed. This could be a great step forward for our project since it would allow non-Emacs, non- XML folks to write documents. If I use OO.o styles as follows, the XSLT stuff makes valid DocBook XML: OO.o format: (OO.o styles are in [] brackets) -=-=-=- [Heading1]My Title[/Heading1] [Body text]Some text.[/Body text] [Heading2]Another Chunk[/Heading2] [Body text]Some more text.[/Body text] Produces this DocBook XML 4.1.2 text (although the indentation may not match PSGML): -=-=-=- <sect1> <title>My Title</title> <para>Some text.</para> <sect2> <title>Another Chunk</title> <para>Some more text.</para> </sect2> </sect1> It's a great start, especially considering what a confusing PITA it is for a newbie to install any DocBook functionality in OO.o 1.1.x. I haven't fully investigated yet how well the XSLT stuff in OO.o works to import documents. In other words, will it serve well for collaboration between people who are not using the same tool? I don't know, but the barrier certainly seems significantly lower for first-time contributors, if they prefer to write in a full-featured WYSIWYG word processor. Next up -- and after the IG is out and the DocG is revving up -- I may look into creating an OO.o style template that would be even more WYSIWYG than what's there now. It would include properly formatted admonitions with graphics, coloration to match the HTML build, etc. This is just a mini-news bulletin, not a call for a new toolchain. However, since the tool is available and may provide functionality for new contributors, it will probably be addressed in the Documentation Guide. -- Paul W. Frields, RHCE http://paul.frields.org/ gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/

3 4

Red Hat Magazine, issue 7
by Paul W. Frields 23 May '05

23 May '05

Fellow scribes and scribblers, The illustrious editor-in-chief, Tammy Fox, is apparently too modest to announce it here, but Red Hat Magazine #7 is out! RHM7 (that's what the new teaser poster calls it -- look for it in your neighborhood movie theater) has the following Fedora-related articles: * Installing Fedora Core on the Mac mini, by Colin Charles * FUDCon 2: Coming to a LinuxTag near you * Fedora Project Status Report, by Greg DeKoenigsberg Of course, there's also the usual amount of up-to-the-minute news, excellent tutorial articles on VNC and MySQL, a cool bit on availability and a great feature on open source licensing that you (or your boss) might enjoy. I really look forward to this online magazine every month, and I'm so glad to see the new method of online publishing has really taken off for RHM. If you want to keep on top of new issue releases, you can subscribe to the RSS 2.0 feed here: http://www.redhat.com/magazine/rss20.xml Tammy certainly doesn't need me to do PR for the magazine; I just wanted to make sure everyone knew the new issue was out. The new issue will probably be out right after the FC4 release, so hopefully we can submit a small blurb about the Installation Guide and other FDP happenings in time for the Fedora Project Status Report in RHM8. -- Paul W. Frields, RHCE http://paul.frields.org/ gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/

4 5

fdp css negates docbook attributes
by Thomas Jones 18 May '05

18 May '05

Has anyone here noticed that the css declarations removes the capabilities of various docbook elements? For instance, I have some data that I have put into a table. I followed all semantics of the CALS table attributes that docbook utilizes. Yet, I am unable to successfully alter the table attributes and their appropriate values to achieve the desired outcome --- because of html attribute inclusion by css. i.e. <table id="entities" frame="all"><title>Demonstration Entities and Relationships</title> <tgroup cols="3" align="left" colsep="0" rowsep="0"> <thead> ... Now this should result in the following: A framed table with three columns, all aligned to the left, and all rows and columns NOT seperated. But instead I get a framed table with a header background color of #a9a9a9, a body background color of #dcdcdc, all aligned to the left, and all rows and columns ARE seperated. To do this, i should have declared so using the bgcolor and border attributes. This breaks the element. Thomas

4 5

After wading through Bugzilla...
by David A. Lane, KG4GIY 17 May '05

17 May '05

Good evening all, My name is David Lane and among other things, I have been working with Red Hat since version 3 and I am currently working with Fedora Core 2 and 3 in different applications (such as Nessus for network testing). Anyway, looking around in Bugzilla, which I have not really been in since RH 8 when I had problems with the kernel on a laptop, has left me a little confused. I will probably be able to figure it out once I look at it again, but based on what I was seeing, it looks like there is a request for some over the wire (network) installation instructions (which have not been written) as part of a general installation guide - which also seems to be needed, a review of the samba-ldap-tutorial (#129739) and someone wanted an HCL update (along with a few other already written items). Am I reading this right? I have to get CVS up and running and grab the latest snap shot as well. Anyway, with a little luck, I think I might be able to find a niche where I can add to the overall whole. Personally, I am working on IPSec on the side, but I haven't started tinkering with it on the FC side yet... DAVID Oh, and I have also been interested in updating a very old HOWTO on AX.25 (the "ham" howto). But I need to pick up a TNC first. David A. Lane, KG4GIY EC/RO Prince William County ARES®/RACES +1.703.361.3042 http://www.qsl.net/pwcares/

2 1

Self-Introduction
by Neil Horman 17 May '05

17 May '05

Hey all, My self introduction: Name: Neil Horman Location: Raleigh, NC, USA. Profession: Software Engineer Company: Red Hat Goals: I'm planning on packaging utilities that are currently rather lacking in documentation (specifically git, cogito, etc). My current goal is to provide documentation as I build/release the pacakaged utilities. No good tool is complete without docs, right? I'd offer to help out with proofreading other documentation, but I really don't think anyone wants me doing that :) Historical Qualifications: I've been contributing to the Linux kernel and several open source projects (cscope, sctp, nfs, etc) for a year or so now, and publically active on thier requisite mailing lists for a few years. I've not had alot of docs experience, but I figure I'm going to try to build that up as I push more packages out to extras in the future. GPG key: pub 1024D/92A74FA1 2003-08-28 Neil Horman (my gmail address) <nhorman(a)gmail.com> Key fingerprint = 00BE 52A6 EB8E 979F 117E 101D 33E6 C4A1 92A7 4FA1 uid Neil Horman <nhorman(a)redhat.com> sub 2048g/C6D2F3B3 2003-08-28 Regards Neil -- /*************************************************** *Neil Horman *Software Engineer *Red Hat, Inc. *nhorman(a)redhat.com *gpg keyid: 1024D / 0x92A74FA1 *http://pgp.mit.edu ***************************************************/

1 0

Callout style + error
by Thomas Jones 17 May '05

17 May '05

I've attempted to determine some information about the callout images used in fedora's documentation --- to no avail. So I bow to the mercy of the mailinglist and ask for help. What is the standardized styling and location of the callout images? I have built custom callouts for current development of my xml sources; but didn't want to stray from standard practice. Also I came across a peculiar problem declaring the xsl parameter using xmlto. For some reason due to the java implemented processor, I am getting a ColumnWidth error. The only alteration performed was to include an extension stylesheet for the declaration of a new image path. :-( Admittedly, I have never used xmlto and prefer xsltproc. However it might be a moot point if the standard path is acceptable. Thanks, Thomas

5 12

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs May 2005