Date: Tue, 20 Mar 2012 22:01:55 GMT From: Rene Ladan <rene@FreeBSD.org> To: Perforce Change Reviews <perforce@FreeBSD.org> Subject: PERFORCE change 208286 for review Message-ID: <201203202201.q2KM1tge053452@skunkworks.freebsd.org>
next in thread | raw e-mail | index | archive | help
http://p4web.freebsd.org/@@208286?ac=10 Change 208286 by rene@rene_acer on 2012/03/20 22:00:57 IFC Affected files ... .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#51 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml#132 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/cups/article.sgml#6 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/port-mentor-guidelines/article.sgml#2 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/pr-guidelines/article.sgml#10 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/vinum/article.sgml#2 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/arch-handbook/mac/chapter.sgml#3 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/arch-handbook/pccard/chapter.sgml#2 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/dev-model/book.sgml#7 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml#37 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml#19 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/install/chapter.sgml#29 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/virtualization/chapter.sgml#15 integrate .. //depot/projects/docproj_nl/www/en/releases/8.3R/Makefile#2 integrate .. //depot/projects/docproj_nl/www/en/releases/8.3R/errata.html#1 branch .. //depot/projects/docproj_nl/www/en/releases/8.3R/hardware.html#1 branch .. //depot/projects/docproj_nl/www/en/releases/8.3R/readme.html#1 branch .. //depot/projects/docproj_nl/www/en/releases/8.3R/relnotes-detailed.html#1 branch Differences ... ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/committers-guide/article.sgml#51 (text+ko) ==== @@ -9,7 +9,7 @@ <corpauthor>The &os; Documentation Project</corpauthor> - <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v 1.313 2012/03/11 15:32:12 gjb Exp $</pubdate> + <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v 1.315 2012/03/20 02:53:54 eadler Exp $</pubdate> <copyright> <year>1999</year> @@ -1802,9 +1802,7 @@ <title>Merging with <acronym>SVN</acronym></title> <para>This section deals with merging code from one branch to - another (typically, from head to a stable branch). For - information about vendor imports, see the next section in - this primer.</para> + another (typically, from head to a stable branch).</para> <note> <para>In all examples below, <literal>$FSVN</literal> @@ -2717,16 +2715,14 @@ This lets you query the PR database without needing to be connected to the Internet.</para> - <procedure> - <title>Using a local GNATS tree</title> + <sect2> + <title>Mirroring the GNATS Tree</title> - <step> - <para>If you are not already downloading the GNATS tree, add this line - to your <filename>supfile</filename>, and re-sup. Note that since - GNATS is not under CVS control it has no tag, so if you are adding - it to your existing <filename>supfile</filename> it should appear - before any <quote>tag=</quote> entry as these remain active once set. - </para> + <para>It is possible to mirror the GNATS database by adding this line + to your <filename>supfile</filename>. Note that since + GNATS is not under CVS control it has no tag, so if you are adding + it to your existing <filename>supfile</filename> it should appear + before any <quote>tag=</quote> entry as these remain active once set.</para> <programlisting>gnats release=current prefix=/usr</programlisting> @@ -2740,75 +2736,34 @@ base</literal> setting in your <filename>supfile</filename>.</para> </footnote>.</para> + </sect2> - <programlisting>gnats/[a-ce-z]*</programlisting> + <sect2 id="gnatstools"> + <title>Useful Tools</title> - <para>The rest of these examples assume you have only supped the - <literal>docs</literal> category. Adjust them as necessary, - depending on the categories you are syncing.</para> - </step> + <para>Other than <command>edit-pr</command> there are a + collection of tools in <filename>~gnats/tools/</filename> + on <hostid>freefall</hostid> which can make + working with PRs much easier.</para> - <step> - <para>Install the GNATS port from - <filename>ports/databases/gnats</filename>. This will place the - various GNATS directories under - <filename>$PREFIX/share/gnats</filename>.</para> - </step> + <para><command>open-pr</command>, <command>close-pr</command>, + <command>take-pr</command>, and <command>feedback-pr</command> + take PR numbers as arguments and then ask you to select from a + preexisting list of change reasons or let you type in your + own.</para> - <step> - <para>Symlink the GNATS directories you are supping under the version - of GNATS you have installed.</para> + <para><command>change-pr</command> is a multi purpose tool + that lets you make multiple changes at the same time with one + command.</para> - <screen>&prompt.root; <userinput>cd /usr/local/share/gnats/gnats-db</userinput> -&prompt.root; <userinput>ln -s /usr/gnats/docs</userinput></screen> - - <para>Repeat as necessary, depending on how many GNATS categories you - are syncing.</para> - </step> - - <step> - <para>Update the GNATS <filename>categories</filename> file with these - categories. The file is - <filename>$PREFIX/share/gnats/gnats-db/gnats-adm/categories</filename>.</para> - - <programlisting># This category is mandatory -pending:Category for faulty PRs:gnats-admin: -# -# FreeBSD categories -# -docs:Documentation Bug:freebsd-doc:</programlisting> - </step> - - <step> - <para>Run <filename>$PREFIX/libexec/gnats/gen-index</filename> to - recreate the GNATS index. The output has to be redirected to - <filename>$PREFIX/share/gnats/gnats-db/gnats-adm/index</filename>. - You can do this periodically from &man.cron.8;, or run &man.cvsup.1; - from a shell script that does this as well.</para> - - <screen>&prompt.root; <userinput>/usr/local/libexec/gnats/gen-index \ - > /usr/local/share/gnats/gnats-db/gnats-adm/index</userinput></screen> - </step> - - <step> - <para>Test the configuration by querying the PR database. This - command shows open <literal>docs</literal> PRs.</para> - - <screen>&prompt.root; <userinput>query-pr -c docs -s open</userinput></screen> - - </step> - - <step> - <para>Pick a PR and close it.</para> - </step> - </procedure> - - <note> - <para>This procedure only works to allow you to view and query the PRs - locally. To edit or close them you will still have to log in to - <hostid>freefall</hostid> and do it from there.</para> - </note> - </sect1> + <para>For example, to assign PR 123456 to yourself type + <command>take-pr <replaceable>123456</replaceable></command>. + If you want to set the PR to patched awaiting an MFC at + the same time use: + <command>change-pr -t -p -m "awaiting MFC" + <replaceable>123456</replaceable></command></para> + </sect2> + </sect1> <sect1 id="people"> <title>Who's Who</title> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml#132 (text+ko) ==== @@ -1,4 +1,4 @@ -<!-- $FreeBSD: doc/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml,v 1.1071 2012/03/15 12:49:10 culot Exp $ --> +<!-- $FreeBSD: doc/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml,v 1.1073 2012/03/19 09:56:15 culot Exp $ --> <!-- NOTE TO COMMITTERS: Contributors lists are sorted in alphabetical order by first name. @@ -10476,6 +10476,11 @@ </listitem> <listitem> + <para>Vladimir Gorelov + <email>virtual.lark@gmail.com</email></para> + </listitem> + + <listitem> <para>Vladimir Kurtikov <email>vk@vk.pp.ru</email></para> </listitem> @@ -10725,6 +10730,11 @@ </listitem> <listitem> + <para>Yi-Hsuan Hsin + <email>mhsin@mhsin.org</email></para> + </listitem> + + <listitem> <para>Ying-Chieh Chen <email>yinjieh@csie.nctu.edu.tw</email></para> </listitem> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/cups/article.sgml#6 (text+ko) ==== @@ -7,7 +7,7 @@ <article> <articleinfo> <title>CUPS on FreeBSD</title> - <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/cups/article.sgml,v 1.6 2012/02/11 04:28:17 eadler Exp $</pubdate> + <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/cups/article.sgml,v 1.7 2012/03/17 03:12:26 eadler Exp $</pubdate> <authorgroup> <author> <firstname>Chess</firstname> @@ -330,7 +330,7 @@ # Set the default printer/job policies... <Policy default> - # Job-related operations must be done by the owner or an adminstrator... + # Job-related operations must be done by the owner or an administrator... <Limit Send-Document Send-URI Hold-Job Release-Job Restart-Job Purge-Jobs \ Set-Job-Attributes Create-Job-Subscription Renew-Subscription Cancel-Subscription \ Get-Notifications Reprocess-Job Cancel-Current-Job Suspend-Current-Job Resume-Job \ @@ -339,7 +339,7 @@ Order deny,allow </Limit> - # All administration operations require an adminstrator to authenticate... + # All administration operations require an administrator to authenticate... <Limit Pause-Printer Resume-Printer Set-Printer-Attributes Enable-Printer \ Disable-Printer Pause-Printer-After-Current-Job Hold-New-Jobs Release-Held-New-Jobs \ Deactivate-Printer Activate-Printer Restart-Printer Shutdown-Printer Startup-Printer \ ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/port-mentor-guidelines/article.sgml#2 (text+ko) ==== @@ -11,7 +11,7 @@ <corpauthor>The &os; Ports Management Team</corpauthor> </authorgroup> - <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/port-mentor-guidelines/article.sgml,v 1.1 2011/07/20 17:50:26 tabthorpe Exp $</pubdate> + <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/port-mentor-guidelines/article.sgml,v 1.2 2012/03/17 03:12:26 eadler Exp $</pubdate> <copyright> <year>2011</year> @@ -174,7 +174,7 @@ <title>Mentorship duration</title> <para>As the trust level develops and grows, the mentee may be - granted <quote>implicits</quote> commit rights. This can include + granted <quote>implicit</quote> commit rights. This can include trivial changes to a <filename>Makefile</filename>, <filename>pkg-descr</filename> etc. Similarly, it may include <makevar>PORTVERSION</makevar> updates that do not include ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/pr-guidelines/article.sgml#10 (text+ko) ==== @@ -15,7 +15,7 @@ <articleinfo> <title>Problem Report Handling Guidelines</title> - <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/pr-guidelines/article.sgml,v 1.39 2011/11/03 20:56:02 manolis Exp $</pubdate> + <pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/pr-guidelines/article.sgml,v 1.40 2012/03/17 02:52:34 eadler Exp $</pubdate> <legalnotice id="trademarks" role="trademarks"> &tm-attrib.freebsd; @@ -535,7 +535,8 @@ </row> <row> - <entry>problem with &man.sysinstall.8;</entry> + <entry>problem with &man.sysinstall.8; or + &man.bsdinstall.8;</entry> <entry>bin</entry> <entry>freebsd-sysinstall</entry> <entry>mailing list</entry> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/vinum/article.sgml#2 (text+ko) ==== @@ -1,4 +1,4 @@ -<!-- $FreeBSD: doc/en_US.ISO8859-1/articles/vinum/article.sgml,v 1.16 2006/08/29 19:45:44 blackend Exp $ --> +<!-- $FreeBSD: doc/en_US.ISO8859-1/articles/vinum/article.sgml,v 1.17 2012/03/20 08:56:30 pluknet Exp $ --> <!-- FreeBSD Documentation Project --> <!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [ @@ -2291,7 +2291,7 @@ printf DLOUT "%4s%9d%9d%10s\n", "$vip:", $totsiz+$cfgsiz, $minoff-$cfgsiz, 'vinum'; } else { - # No need to mess with size size and offset if there was no swap + # No need to mess with size and offset if there was no swap printf DLOUT "%4s%9d%9d%10s\n", "$vip:", $totsiz, $minoff, 'vinum'; } ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/arch-handbook/mac/chapter.sgml#3 (text+ko) ==== @@ -29,7 +29,7 @@ OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - $FreeBSD: doc/en_US.ISO8859-1/books/arch-handbook/mac/chapter.sgml,v 1.46 2010/08/02 16:15:46 bcr Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/arch-handbook/mac/chapter.sgml,v 1.47 2012/03/17 04:53:51 eadler Exp $ --> <chapter id="mac"> @@ -2952,7 +2952,7 @@ from the passed devfs vnode label. This call will be made when a devfs vnode has been successfully relabeled to commit the label change such that it lasts even if the vnode is - recycled. It will also be made when when a symlink is + recycled. It will also be made when a symlink is created in devfs, following a call to <function>mac_vnode_create_from_vnode</function> to initialize the vnode label.</para> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/arch-handbook/pccard/chapter.sgml#2 (text+ko) ==== @@ -1,7 +1,7 @@ <!-- The FreeBSD Documentation Project - $FreeBSD: doc/en_US.ISO8859-1/books/arch-handbook/pccard/chapter.sgml,v 1.12 2006/01/05 20:03:34 delphij Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/arch-handbook/pccard/chapter.sgml,v 1.16 2012/03/19 04:57:07 wblock Exp $ --> <chapter id="pccard"> @@ -18,12 +18,8 @@ <sect1 id="pccard-adddev"> <title>Adding a device</title> - <para>The procedure for adding a new device to the list of - supported pccard devices has changed from the system used - through FreeBSD 4. In prior versions, editing a file in - <filename>/etc</filename> to list the device was necessary. - Starting in FreeBSD 5.0, devices drivers know what devices they - support. There is now a table of supported devices in the + <para>Devices drivers know what devices they + support. There is a table of supported devices in the kernel that drivers use to attach to a device.</para> <sect2 id="pccard-overview"> @@ -31,84 +27,83 @@ <indexterm><primary>CIS</primary></indexterm> <para>PC Cards are identified in one of two ways, both based on - information in the <acronym>CIS</acronym> of the card. The - first method is to use numeric manufacturer and product - numbers. The second method is to use the human readable - strings that are also contained in the CIS. The PC Card bus - uses a centralized database and some macros to facilitate a - design pattern to help the driver writer match devices to his - driver.</para> + information in the <acronym>CIS</acronym> of the card. The + first method is to use numeric manufacturer and product + numbers. The second method is to use the human readable + strings that are also contained in the CIS. The PC Card bus + uses a centralized database and some macros to facilitate a + design pattern to help the driver writer match devices to his + driver.</para> - <para>There is a widespread practice of one company developing a - reference design for a PC Card product and then selling this - design to other companies to market. Those companies refine - the design, market the product to their target audience or - geographic area and put their own name plate onto the card. - However, the refinements to the physical card typically are - very minor, if any changes are made at all. Often, however, - to strengthen their branding of their version of the card, - these vendors will place their company name in the human - strings in the CIS space, but leave the manufacturer and - product ids unchanged.</para> + <para>OEMs manufacturers often develop a reference design for + a PC Card product sell this design to other companies to + market. Those companies refine + the design, market the product to their target audience or + geographic area and put their own name plate onto the card. + The refinements to the physical card typically are + very minor, if any changes are made at all. However, + to strengthen their brand, + these vendors place their company name in the human + strings in the CIS space, but leave the manufacturer and + product ids unchanged.</para> <indexterm><primary>NetGear</primary></indexterm> <indexterm><primary>Linksys</primary></indexterm> <indexterm><primary>D-Link</primary></indexterm> - <para>Because of the above practice, it is a smaller work load - for FreeBSD to use the numeric IDs. It also introduces some - minor complications into the process of adding IDs to the - system. One must carefully check to see who really made the - card, especially when it appears that the vendor who made the - card from might already have a different manufacturer id - listed in the central database. Linksys, D-Link and NetGear - are a number of US Manufacturers of LAN hardware that often - sell the same design. These same designs can be sold in Japan - under names such as Buffalo and Corega. Yet often, these - devices will all have the same manufacturer and product - id.</para> + <para>Because of this practice, FreeBSD drivers tend to + use the numeric IDs. Using numeric IDs and a centralized + database complicates adding IDs and support for cards to the + system. One must carefully check to see who really made the + card, especially when it appears that the vendor who made the + card from might already have a different manufacturer id + listed in the central database. Linksys, D-Link and NetGear + are a number of US Manufacturers of LAN hardware that often + sell the same design. These same designs can be sold in Japan + under names such as Buffalo and Corega. Yet often, these + devices will all have the same manufacturer and product + id.</para> - <para>The PC Card bus keeps its central database of card - information, but not which driver is associated with them, in - <filename>/sys/dev/pccard/pccarddevs</filename>. It also - provides a set of macros that allow one to easily construct - simple entries in the table the driver uses to claim - devices.</para> + <para>The PC Card bus code keeps a central database of card + information, but not which driver is associated with them, in + <filename>/sys/dev/pccard/pccarddevs</filename>. It also + provides a set of macros that allow one to easily construct + simple entries in the table the driver uses to claim + devices.</para> <para>Finally, some really low end devices do not contain - manufacturer identification at all. These devices require - that one matches them using the human readable CIS strings. - While it would be nice if we did not need this method as a - fallback, it is necessary for some very low end CD-ROM players - that are quite popular. This method should generally be - avoided, but a number of devices are listed in this section - because they were added prior to the recognition of the - <acronym>OEM</acronym> nature of the PC Card business. When - adding new devices, prefer using the numeric method.</para> - + manufacturer identification at all. These devices require + that one matches them using the human readable CIS strings. + While it would be nice if we did not need this method as a + fallback, it is necessary for some very low end CD-ROM players + and ethernet cards. This method should generally be + avoided, but a number of devices are listed in this section + because they were added prior to the recognition of the + <acronym>OEM</acronym> nature of the PC Card business. When + adding new devices, prefer using the numeric method.</para> </sect2> <sect2 id="pccard-pccarddevs"> <title>Format of <filename>pccarddevs</filename></title> <para>There are four sections of the - <filename>pccarddevs</filename> files. The first section - lists the manufacturer numbers for those vendors that use - them. This section is sorted in numerical order. The next - section has all of the products that are used by these - vendors, along with their product ID numbers and a description - string. The description string typically is not used (instead - we set the device's description based on the human readable - CIS, even if we match on the numeric version). These two - sections are then repeated for those devices that use the - string matching method. Finally, C-style comments are allowed - anywhere in the file.</para> + <filename>pccarddevs</filename> files. The first section + lists the manufacturer numbers for those vendors that use + them. This section is sorted in numerical order. The next + section has all of the products that are used by these + vendors, along with their product ID numbers and a description + string. The description string typically is not used (instead + we set the device's description based on the human readable + CIS, even if we match on the numeric version). These two + sections are then repeated for those devices that use the + string matching method. Finally, C-style comments are allowed + anywhere in the file.</para> <para>The first section of the file contains the vendor IDs. - Please keep this list sorted in numeric order. Also, please - coordinate changes to this file because we share it with - NetBSD to help facilitate a common clearing house for this - information. For example:</para> + Please keep this list sorted in numeric order. Also, please + coordinate changes to this file because we share it with + NetBSD to help facilitate a common clearing house for this + information. For example:</para> <programlisting>vendor FUJITSU 0x0004 Fujitsu Corporation vendor NETGEAR_2 0x000b Netgear @@ -116,26 +111,26 @@ vendor SANDISK 0x0045 Sandisk Corporation</programlisting> <para>shows the first few vendor ids. Chances are very good - that the <literal>NETGEAR_2</literal> entry is really an OEM - that NETGEAR purchased cards from and the author of support - for those cards was unaware at the time that Netgear was using - someone else's id. These entries are fairly straightforward. - There is the vendor keyword used to denote the kind of line - that this is. There is the name of the vendor. This name will - be repeated later in the pccarddevs file, as well as used in - the driver's match tables, so keep it short and a valid C - identifier. There is a numeric ID, in hex, for the - manufacturer. Do not add IDs of the form - <literal>0xffffffff</literal> or <literal>0xffff</literal> - because these are reserved ids (the former is 'no id set' - while the latter is sometimes seen in extremely poor quality - cards to try to indicate 'none). Finally there is a string - description of the company that makes the card. This string - is not used in FreeBSD for anything but commentary - purposes.</para> + that the <literal>NETGEAR_2</literal> entry is really an OEM + that NETGEAR purchased cards from and the author of support + for those cards was unaware at the time that Netgear was using + someone else's id. These entries are fairly straightforward. + There is the vendor keyword used to denote the kind of line + that this is. There is the name of the vendor. This name + will be repeated later in the pccarddevs file, as well as used + in the driver's match tables, so keep it short and a valid C + identifier. There is a numeric ID, in hex, for the + manufacturer. Do not add IDs of the form + <literal>0xffffffff</literal> or <literal>0xffff</literal> + because these are reserved ids (the former is 'no id set' + while the latter is sometimes seen in extremely poor quality + cards to try to indicate 'none). Finally there is a string + description of the company that makes the card. This string + is not used in FreeBSD for anything but commentary + purposes.</para> <para>The second section of the file contains the products. As - you can see in the following example:</para> + you can see in the following example:</para> <programlisting>/* Allied Telesis K.K. */ product ALLIEDTELESIS LA_PCM 0x0002 Allied Telesis LA-PCM @@ -144,75 +139,77 @@ product ARCHOS ARC_ATAPI 0x0043 MiniCD</programlisting> <para>the format is similar to the vendor lines. There is the - product keyword. Then there is the vendor name, repeated from - above. This is followed by the product name, which is used by - the driver and should be a valid C identifier, but may also - start with a number. There is then the product id for this - card, in hex. As with the vendors, there is the same - convention for <literal>0xffffffff</literal> and - <literal>0xffff</literal>. Finally, there is a string - description of the device itself. This string typically is - not used in FreeBSD, since FreeBSD's pccard bus driver will - construct a string from the human readable CIS entries, but it - can be used in the rare cases where this is somehow - insufficient. The products are in alphabetical order by - manufacturer, then numerical order by product id. They have a - C comment before each manufacturer's entries and there is a - blank line between entries.</para> + product keyword. Then there is the vendor name, repeated from + above. This is followed by the product name, which is used by + the driver and should be a valid C identifier, but may also + start with a number. There is then the product id for this + card, in hex. As with the vendors, there is the same + convention for <literal>0xffffffff</literal> and + <literal>0xffff</literal>. Finally, there is a string + description of the device itself. This string typically is + not used in FreeBSD, since FreeBSD's pccard bus driver will + construct a string from the human readable CIS entries, but it + can be used in the rare cases where this is somehow + insufficient. The products are in alphabetical order by + manufacturer, then numerical order by product id. They have a + C comment before each manufacturer's entries and there is a + blank line between entries.</para> <para>The third section is like the previous vendor section, but - with all of the manufacturer numeric ids as - <literal>-1</literal>. <literal>-1</literal> means - <quote>match anything you find</quote> in the FreeBSD pccard - bus code. Since these are C identifiers, their names must be - unique. Otherwise the format is identical to the first - section of the file.</para> + with all of the manufacturer numeric ids as + <literal>-1</literal>. <literal>-1</literal> means + <quote>match anything you find</quote> in the FreeBSD pccard + bus code. Since these are C identifiers, their names must be + unique. Otherwise the format is identical to the first + section of the file.</para> <para>The final section contains the entries for those cards - that we must match with string entries. This sections' format - is a little different than the generic section:</para> + that we must match with string entries. This sections' format + is a little different than the generic section:</para> <programlisting>product ADDTRON AWP100 { "Addtron", "AWP-100&spWireless&spPCMCIA", "Version&sp01.02", NULL } product ALLIEDTELESIS WR211PCM { "Allied&spTelesis&spK.K.", "WR211PCM", NULL, NULL } Allied Telesis WR211PCM</programlisting> <para>We have the familiar product keyword, followed by the - vendor name followed by the card name, just as in the second - section of the file. However, then we deviate from that - format. There is a {} grouping, followed by a number of - strings. These strings correspond to the vendor, product and - extra information that is defined in a CIS_INFO tuple. These - strings are filtered by the program that generates - <filename>pccarddevs.h</filename> to replace &sp with a - real space. NULL entries mean that that part of the entry - should be ignored. In the example I have picked, there is a bad - entry. It should not contain the version number in it unless - that is critical for the operation of the card. Sometimes - vendors will have many different versions of the card in the - field that all work, in which case that information only makes - it harder for someone with a similar card to use it with - FreeBSD. Sometimes it is necessary when a vendor wishes to - sell many different parts under the same brand due to market - considerations (availability, price, and so forth). Then it - can be critical to disambiguating the card in those rare cases - where the vendor kept the same manufacturer/product pair. - Regular expression matching is not available at this - time.</para> - + vendor name followed by the card name, just as in the second + section of the file. However, then we deviate from that + format. There is a {} grouping, followed by a number of + strings. These strings correspond to the vendor, product and + extra information that is defined in a CIS_INFO tuple. These + strings are filtered by the program that generates + <filename>pccarddevs.h</filename> to replace &sp with a + real space. NULL strings mean that the corresponding part + of the entry should be ignored. In the example I have picked, + there is a bad entry. It should not contain the version + number in it unless that is critical for the operation of the + card. Sometimes vendors will have many different versions of + the card in the field that all work, in which case that + information only makes it harder for someone with a similar + card to use it with FreeBSD. Sometimes it is necessary when a + vendor wishes to sell many different parts under the same + brand due to market considerations (availability, price, and + so forth). Then it can be critical to disambiguating the card + in those rare cases where the vendor kept the same + manufacturer/product pair. Regular expression matching is not + available at this time.</para> </sect2> <sect2 id="pccard-probe"> <title>Sample probe routine</title> - <indexterm><primary>PC Card</primary><secondary>probe</secondary></indexterm> + <indexterm> + <primary>PC Card</primary> + <secondary>probe</secondary> + </indexterm> <para>To understand how to add a device to the list of supported - devices, one must understand the probe and/or match routines - that many drivers have. It is complicated a little in FreeBSD - 5.x because there is a compatibility layer for OLDCARD present - as well. Since only the window-dressing is different, an - idealized version will be presented here.</para> + devices, one must understand the probe and/or match routines + that many drivers have. It is complicated a little in FreeBSD + 5.x because there is a compatibility layer for OLDCARD present + as well. Since only the window-dressing is different, an + idealized version will be presented here.</para> -<programlisting>static const struct pccard_product wi_pccard_products[] = { + <programlisting>static const struct pccard_product wi_pccard_products[] = { PCMCIA_CARD(3COM, 3CRWE737A, 0), PCMCIA_CARD(BUFFALO, WLI_PCM_S11, 0), PCMCIA_CARD(BUFFALO, WLI_CF_S11G, 0), @@ -236,72 +233,72 @@ }</programlisting> <para>Here we have a simple pccard probe routine that matches a - few devices. As stated above, the name may vary (if it is not - <function>foo_pccard_probe()</function> it will be - <function>foo_pccard_match()</function>). The function - <function>pccard_product_lookup()</function> is a generalized - function that walks the table and returns a pointer to the - first entry that it matches. Some drivers may use this - mechanism to convey additional information about some cards to - the rest of the driver, so there may be some variance in the - table. The only requirement is that if you have a different - table, the first element of the structure you have a table of - be a struct pccard_product.</para> + few devices. As stated above, the name may vary (if it is not + <function>foo_pccard_probe()</function> it will be + <function>foo_pccard_match()</function>). The function + <function>pccard_product_lookup()</function> is a generalized + function that walks the table and returns a pointer to the + first entry that it matches. Some drivers may use this + mechanism to convey additional information about some cards to + the rest of the driver, so there may be some variance in the + table. The only requirement is that if you have a different + table, the first element of the structure you have a table of + be a struct pccard_product.</para> <para>Looking at the table - <structname>wi_pccard_products</structname>, one notices that - all the entries are of the form - <function>PCMCIA_CARD(<replaceable>foo</replaceable>, - <replaceable>bar</replaceable>, - <replaceable>baz</replaceable>)</function>. The - <replaceable>foo</replaceable> part is the manufacturer id - from <filename>pccarddevs</filename>. The - <replaceable>bar</replaceable> part is the product. The - <replaceable>baz</replaceable> is the expected function number - that for this card. Many pccards can have multiple functions, - and some way to disambiguate function 1 from function 0 is - needed. You may see <literal>PCMCIA_CARD_D</literal>, which - includes the device description from the - <filename>pccarddevs</filename> file. You may also see - <literal>PCMCIA_CARD2</literal> and - <literal>PCMCIA_CARD2_D</literal> which are used when you need - to match CIS both CIS strings and manufacturer numbers, in the - <quote>use the default description</quote> and <quote>take the - description from pccarddevs</quote> flavors.</para> - + <structname>wi_pccard_products</structname>, one notices that + all the entries are of the form + <function>PCMCIA_CARD(<replaceable>foo</replaceable>, + <replaceable>bar</replaceable>, + <replaceable>baz</replaceable>)</function>. The + <replaceable>foo</replaceable> part is the manufacturer id + from <filename>pccarddevs</filename>. The + <replaceable>bar</replaceable> part is the product. The + <replaceable>baz</replaceable> is the expected function number + that for this card. Many pccards can have multiple functions, + and some way to disambiguate function 1 from function 0 is + needed. You may see <literal>PCMCIA_CARD_D</literal>, which + includes the device description from the + <filename>pccarddevs</filename> file. You may also see + <literal>PCMCIA_CARD2</literal> and + <literal>PCMCIA_CARD2_D</literal> which are used when you need + to match CIS both CIS strings and manufacturer numbers, in the + <quote>use the default description</quote> and <quote>take the + description from pccarddevs</quote> flavors.</para> </sect2> <sect2 id="pccard-add"> <title>Putting it all together</title> <para>So, to add a new device, one must do the following steps. - First, one must obtain the identification information from the - device. The easiest way to do this is to insert the device - into a PC Card or CF slot and issue <command>devinfo - -v</command>. You will likely see something like:</para> + First, one must obtain the identification information from the + device. The easiest way to do this is to insert the device + into a PC Card or CF slot and issue + <command>devinfo -v</command>. You will likely see something + like:</para> -<programlisting> cbb1 pnpinfo vendor=0x104c device=0xac51 subvendor=0x1265 subdevice=0x0300 class=0x060700 at slot=10 function=1 + <programlisting> cbb1 pnpinfo vendor=0x104c device=0xac51 subvendor=0x1265 subdevice=0x0300 class=0x060700 at slot=10 function=1 cardbus1 pccard1 unknown pnpinfo manufacturer=0x026f product=0x030c cisvendor="BUFFALO" cisproduct="WLI2-CF-S11" function_type=6 at function=0</programlisting> <para>as part of the output. The manufacturer and product are - the numeric IDs for this product. While the cisvendor and - cisproduct are the strings that are present in the CIS that - describe this product.</para> + the numeric IDs for this product. While the cisvendor and + cisproduct are the strings that are present in the CIS that + describe this product.</para> <para>Since we first want to prefer the numeric option, first - try to construct an entry based on that. The above card has - been slightly fictionalized for the purpose of this example. - The vendor is BUFFALO, which we see already has an - entry:</para> + try to construct an entry based on that. The above card has + been slightly fictionalized for the purpose of this example. + The vendor is BUFFALO, which we see already has an + entry:</para> -<programlisting>vendor BUFFALO 0x026f BUFFALO (Melco Corporation)</programlisting> + <programlisting>vendor BUFFALO 0x026f BUFFALO (Melco Corporation)</programlisting> <para>so we are good there. Looking for an entry for this card, - we do not find one. Instead we find:</para> + we do not find one. Instead we find:</para> -<programlisting>/* BUFFALO */ + <programlisting>/* BUFFALO */ product BUFFALO WLI_PCM_S11 0x0305 BUFFALO AirStation 11Mbps WLAN product BUFFALO LPC_CF_CLT 0x0307 BUFFALO LPC-CF-CLT product BUFFALO LPC3_CLT 0x030a BUFFALO LPC3-CLT Ethernet Adapter @@ -309,22 +306,22 @@ <para>we can just add</para> -<programlisting>product BUFFALO WLI2_CF_S11G 0x030c BUFFALO AirStation ultra 802.11b CF</programlisting> + <programlisting>product BUFFALO WLI2_CF_S11G 0x030c BUFFALO AirStation ultra 802.11b CF</programlisting> <para>to <filename>pccarddevs</filename>. Presently, there is a - manual step to regenerate the - <filename>pccarddevs.h</filename> file used to convey these - identifiers to the client driver. The following steps - must be done before you can use them in the driver:</para> + manual step to regenerate the + <filename>pccarddevs.h</filename> file used to convey these + identifiers to the client driver. The following steps + must be done before you can use them in the driver:</para> -<screen>&prompt.root; <userinput>cd src/sys/dev/pccard</userinput> + <screen>&prompt.root; <userinput>cd src/sys/dev/pccard</userinput> &prompt.root; <userinput>make -f Makefile.pccarddevs</userinput> </screen> <para>Once these steps are complete, you can add the card to the - driver. That is a simple operation of adding one line:</para> + driver. That is a simple operation of adding one line:</para> -<programlisting>static const struct pccard_product wi_pccard_products[] = { + <programlisting>static const struct pccard_product wi_pccard_products[] = { PCMCIA_CARD(3COM, 3CRWE737A, 0), PCMCIA_CARD(BUFFALO, WLI_PCM_S11, 0), PCMCIA_CARD(BUFFALO, WLI_CF_S11G, 0), @@ -334,46 +331,42 @@ };</programlisting> <para>Note that I have included a '<literal>+</literal>' in the - line before the line that I added, but that is simply to - highlight the line. Do not add it to the actual driver. Once - you have added the line, you can recompile your kernel or module - and try to see if it recognizes the device. If it does and - works, please submit a patch. If it does not work, please - figure out what is needed to make it work and submit a patch. - If it did not recognize it at all, you have done something - wrong and should recheck each step.</para> + line before the line that I added, but that is simply to + highlight the line. Do not add it to the actual driver. Once + you have added the line, you can recompile your kernel or + module and try to see if it recognizes the device. If it does + and works, please submit a patch. If it does not work, please + figure out what is needed to make it work and submit a patch. + If it did not recognize it at all, you have done something + wrong and should recheck each step.</para> <para>If you are a FreeBSD src committer, and everything appears - to be working, then you can commit the changes to the tree. - However, there are some minor tricky things that you need to - worry about. First, you must commit the - <filename>pccarddevs</filename> file to the tree. After you - have done that, you must regenerate - <filename>pccarddevs.h</filename> and commit it as a second - commit (this is to make sure that the right - $FreeBSD$ tag is in the latter file). Finally, - you need to commit the additions to the driver.</para> - + to be working, then you can commit the changes to the tree. + However, there are some minor tricky things that you need to + worry about. First, you must commit the + <filename>pccarddevs</filename> file to the tree. After you + have done that, you must regenerate + <filename>pccarddevs.h</filename> and commit it as a second + commit (this is to make sure that the right + $FreeBSD$ tag is in the latter file). Finally, + you need to commit the additions to the driver.</para> </sect2> <sect2 id="pccard-pr"> <title>Submitting a new device</title> <para>Many people send entries for new devices to the author - directly. Please do not do this. Please submit them as a PR - and send the author the PR number for his records. This makes - sure that entries are not lost. When submitting a PR, it is - unnecessary to include the <filename>pccardevs.h</filename> - diffs in the patch, since those will be regenerated. It is - necessary to include a description of the device, as well as - the patches to the client driver. If you do not know the name, - use OEM99 as the name, and the author will adjust OEM99 - accordingly after investigation. Committers should not commit - OEM99, but instead find the highest OEM entry and commit one - more than that.</para> - + directly. Please do not do this. Please submit them as a PR + and send the author the PR number for his records. This makes + sure that entries are not lost. When submitting a PR, it is + unnecessary to include the <filename>pccardevs.h</filename> + diffs in the patch, since those will be regenerated. It is + necessary to include a description of the device, as well as + the patches to the client driver. If you do not know the + name, use OEM99 as the name, and the author will adjust OEM99 + accordingly after investigation. Committers should not commit + OEM99, but instead find the highest OEM entry and commit one + more than that.</para> </sect2> - </sect1> - </chapter> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/dev-model/book.sgml#7 (text+ko) ==== @@ -23,7 +23,7 @@ - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - SUCH DAMAGE. - - - $FreeBSD: doc/en_US.ISO8859-1/books/dev-model/book.sgml,v 1.21 2012/01/27 22:21:39 gavin Exp $ + - $FreeBSD: doc/en_US.ISO8859-1/books/dev-model/book.sgml,v 1.22 2012/03/17 04:53:51 eadler Exp $ --> <!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [ @@ -811,7 +811,7 @@ Maintainership means that that person is responsible for what is allowed to go into that area of the code and has the final say should disagreements over the code occur. This - involves involves proactive work aimed at stimulating + involves proactive work aimed at stimulating contributions and reactive work in reviewing commits. </para> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml#37 (text+ko) ==== @@ -1,7 +1,7 @@ <!-- The FreeBSD Documentation Project - $FreeBSD: doc/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml,v 1.445 2012/01/31 05:11:07 wblock Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml,v 1.446 2012/03/17 04:53:51 eadler Exp $ --> <chapter id="advanced-networking"> @@ -2216,7 +2216,7 @@ <para>There are also many useful statistics maintained by the 802.11 layer; the <command>wlanstats</command> tool - will dump these informations. These statistics should + will dump this information. These statistics should identify all errors identified by the 802.11 layer. Beware however that some errors are identified in the device drivers that lie below the 802.11 layer so they may ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml#19 (text+ko) ==== @@ -1,7 +1,7 @@ <!-- The FreeBSD Documentation Project - $FreeBSD: doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml,v 1.99 2012/02/13 23:21:10 eadler Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml,v 1.100 2012/03/17 04:53:51 eadler Exp $ --> <chapter id="firewalls"> @@ -2939,7 +2939,7 @@ # Interface facing Public Internet (Outbound Section) # Interrogate session start requests originating from behind the # firewall on the private network or from this gateway server -# destine for the public Internet. +# destined for the public Internet. ################################################################# # Allow out access to my ISP's Domain name server. ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/install/chapter.sgml#29 (text+ko) ==== @@ -1,7 +1,7 @@ <!-- The FreeBSD Documentation Project - $FreeBSD: doc/en_US.ISO8859-1/books/handbook/install/chapter.sgml,v 1.445 2012/02/19 20:34:17 gjb Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/handbook/install/chapter.sgml,v 1.446 2012/03/17 04:53:52 eadler Exp $ --> <chapter id="install"> @@ -4084,7 +4084,7 @@ exist for this to work. For details about the format of <filename>/etc/fstab</filename>, see &man.fstab.5;.</para></note> - <para>A typicall call to &man.mount.8; for a &ms-dos; file system + <para>A typical call to &man.mount.8; for a &ms-dos; file system looks like:</para> <screen>&prompt.root; <userinput>mount -t msdosfs /dev/ad0s1 /mnt</userinput></screen> ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/virtualization/chapter.sgml#15 (text+ko) ==== @@ -1,7 +1,7 @@ <!-- The FreeBSD Documentation Project - $FreeBSD: doc/en_US.ISO8859-1/books/handbook/virtualization/chapter.sgml,v 1.32 2012/02/21 03:48:23 wblock Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/handbook/virtualization/chapter.sgml,v 1.33 2012/03/17 04:53:52 eadler Exp $ --> <chapter id="virtualization"> @@ -281,7 +281,7 @@ </sect3> </sect2> <!-- -Deactive/hide this section as the instruction in there do NOT work anyore: +Deactive/hide this section as the instructions in there do NOT work anymore: - FreeBSD 7.0 has reached its EOL a long time ago. - The needed files from www.fsmware.com are not available anymore, as the server is dead. So it is impossible to follow the instructions in here. ==== //depot/projects/docproj_nl/www/en/releases/8.3R/Makefile#2 (text+ko) ==== @@ -1,4 +1,4 @@ -# $FreeBSD: www/en/releases/8.3R/Makefile,v 1.1 2012/02/05 11:12:40 bz Exp $ +# $FreeBSD: www/en/releases/8.3R/Makefile,v 1.2 2012/03/18 12:09:03 hrs Exp $ >>> TRUNCATED FOR MAIL (1000 lines) <<<
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201203202201.q2KM1tge053452>