Mailing-List: contact cygwin-help@sourceware.cygnus.com; run by ezmlm List-Subscribe: List-Archive: List-Post: List-Help: , Sender: cygwin-owner@sources.redhat.com Delivered-To: mailing list cygwin@sources.redhat.com Message-ID: <3BAF5B9B.1030408@ece.gatech.edu> Date: Mon, 24 Sep 2001 12:13:15 -0400 From: Charles Wilson User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:0.9.2) Gecko/20010726 Netscape6/6.1 X-Accept-Language: en-us MIME-Version: 1.0 To: David Starks-Browning CC: cygwin@cygwin.com Subject: Re: FAQ URLs (Was: Where are instructions for contributing package to cygwin?) References: <3BAE6B03.6080801@ece.gatech.edu> <4235-Mon24Sep2001101512+0100-starksb@ebi.ac.uk> Content-Type: text/plain; charset=us-ascii; format=flowed Content-Transfer-Encoding: 7bit David Starks-Browning wrote: > On Sunday 23 Sep 01, Charles Wilson writes: > >>4. As far as the mechanics of getting a package prepared and uploaded, >>that's kinda in flux right now; partly because we're in the processes of >>vetting the new setup...but for some pointers, take a look here: >> >>http://www.cygwin.com/faq/faq.html#SEC83 >> > > Until such time as I can figure out how to avoid it, it's better not > to refer to FAQ entries this way. These change over time as the FAQ > gets updated. It's perhaps a bit more work, but instead say something > like: > > FAQ entry "How do I contribute a package?" > > It has the added benefit of forcing people to read the TOC, which > might prove educational itself. Will do. BTW, many FAQs address this issue as follows: 1) number questions in small groups -- e.g "FAQ_2_1_4", "FAQ_2_1_5", etc, according to the TOC structure. (e.g. Chapter 2, Section 1, FAQ 4 or 5). Don't number all FAQs sequentially. (e.g. 001 to 094 spanning 7 chapters and 21 sections) 2) When adding new FAQs, always add at the end of a section 3) When adding new sections, always insert at the end of a chapter 4) New chapters always go at the end of the document 5) When removing a FAQ, leave a placeholder: FAQ 2.1.2: This entry intentionally left blank. That way, old FAQ references never change. The sed tutorial/faq works this way. --Chuck -- Unsubscribe info: http://cygwin.com/ml/#unsubscribe-simple Bug reporting: http://cygwin.com/bugs.html Documentation: http://cygwin.com/docs.html FAQ: http://cygwin.com/faq/