Re: [PATCHES] Developer's FAQ update
Thanks. Your changes have been merged in. --- Gavin Sherry wrote: Diff to the HTML version attached. I'm assuming that you have a script to dump the text version, so I haven't sent a diff against the text version. Note that I have made a few more changes since the last diff. Thanks, Gavin Content-Description: [ Attachment, skipping... ] -- Bruce Momjian| http://candle.pha.pa.us [EMAIL PROTECTED] | (610) 359-1001 + If your life is a hard drive, | 13 Roberts Road + Christ can be your backup.| Newtown Square, Pennsylvania 19073 ---(end of broadcast)--- TIP 4: Don't 'kill -9' the postmaster
Re: [PATCHES] Developer's FAQ update
Diff to the HTML version attached. I'm assuming that you have a script to dump the text version, so I haven't sent a diff against the text version. Note that I have made a few more changes since the last diff. Thanks, Gavin--- doc/src/FAQ/FAQ_DEV.html +++ doc/src/FAQ/FAQ_DEV.html @@ -1,9 +1,9 @@ !DOCTYPE html PUBLIC -//W3C//DTD HTML 3.2//EN HTML HEAD META name=generator content=HTML Tidy, see www.w3.org - + meta http-equiv=Content-Type content=text/html; charset=utf-8 TITLEPostgreSQL Developers FAQ/TITLE /HEAD @@ -12,57 +12,63 @@ H1Developer's Frequently Asked Questions (FAQ) for PostgreSQL/H1 -PLast updated: Fri Oct 15 12:26:50 EDT 2004/P +PLast updated: Wed Dec 1 16:11:11 EST 2004/P PCurrent maintainer: Bruce Momjian (A href= -mailto:[EMAIL PROTECTED];[EMAIL PROTECTED]/A)BR +mailto:[EMAIL PROTECTED];[EMAIL PROTECTED]/A)br / /P PThe most recent version of this document can be viewed at A href= http://www.PostgreSQL.org/docs/faqs/FAQ_DEV.html;http://www.PostgreSQL.org/docs/faqs/FAQ_DEV.html/A./P HR -BR +br / CENTER H2General Questions/H2 /CENTER - A href=#1.11.1/A) How do I get involved in PostgreSQL -development?BR - A href=#1.21.2/A) How do I add a feature or fix a bug?BR - A href=#1.31.3/A) How do I download/update the current source -tree?BR - A href=#1.41.4/A) How do I test my changes?BR -A href=#1.51.5/A) What tools are available for developers?BR - A href=#1.61.6/A) What books are good for developers?BR - A href=#1.71.7/A) What is configure all about?BR - A href=#1.81.8/A) How do I add a new port?BR - A href=#1.91.9/A) Why don't you use threads/raw + A href=#1.11.1/A) How do I get involved in PostgreSQL + development?br / + a href=#1.21.2/a) What development environment is required to + develop code?br / +a href=#1.31.3/a) What areas need work?br / +a href=#1.41.4/a) What do I do after choosing an item to + work on?br / + a href=#1.51.5/a) Where can I learn more about the code?br / + a href=#1.61.6/a) I've developed a patch, what next?br / + A href=#1.71.7/A) How do I download/update the current source + tree?br / + A href=#1.81.8/A) How do I test my changes?br / + A href=#1.91.9/A) What tools are available for developers?br / + A href=#1.101.10/A) What books are good for developers?br / + A href=#1.111.11/A) What is configure all about?br / + A href=#1.121.12/A) How do I add a new port?br / + A href=#1.131.13/A) Why don't you use threads/raw devices/async-I/O, lt;insert your favorite wizz-bang feature - heregt;?BR - A href=#1.101.10/A) How are RPM's packaged?BR - A href=#1.111.11/A) How are CVS branches handled?BR - A href=#1.121.12/A) Where can I get a copy of the SQL - standards?BR - + heregt;?br / + A href=#1.141.14/A) How are RPM's packaged?br / + A href=#1.151.15/A) How are CVS branches handled?br / + A href=#1.161.16/A) Where can I get a copy of the SQL + standards?br / + a href=#1.171.17/a) Where can I get technical assistance?br / CENTER H2Technical Questions/H2 /CENTER A href=#2.12.1/A) How do I efficiently access information in -tables from the backend code?BR +tables from the backend code?br / A href=#2.22.2/A) Why are table, column, type, function, view names sometimes referenced as IName/I or INameData,/I and -sometimes as Ichar *?/IBR +sometimes as Ichar *?/Ibr / A href=#2.32.3/A) Why do we use INode/I and IList/I to -make data structures?BR +make data structures?br / A href=#2.42.4/A) I just added a field to a structure. What else -should I do?BR +should I do?br / A href=#2.52.5/A) Why do we use Ipalloc/I() and -Ipfree/I() to allocate memory?BR - A href=#2.62.6/A) What is ereport()?BR - A href=#2.72.7/A) What is CommandCounterIncrement()?BR - BR +Ipfree/I() to allocate memory?br / + A href=#2.62.6/A) What is ereport()?br / + A href=#2.72.7/A) What is CommandCounterIncrement()?br / + br / HR @@ -73,171 +79,174 @@ H3A name=1.11.1/A) How go I get involved in PostgreSQL development?/H3 -PThis was written by Lamar Owen:/P + pDownload the code and have a look around. See a href=#1.71.7/a. -P2001-06-22/P + pSubscribe to and read the + a href=http://archives.posrgresql.org/pgsql-hackers;pgsql-hackers/a + mailing list (often termed 'hackers'). This is where the major +contributors and core members of the project discuss development./p -BWhat open source development process is used by the PostgreSQL -team?/B +h3a name=1.21.2/a) What development environment is required + to develop code?/h3 -PRead HACKERS for six months (or a full release cycle, whichever -is longer). Really. HACKERS
Re: [PATCHES] Developer's FAQ update
Oops. I'll have a look at that and all try to enhance the document a little further as well. Gavin On Tue, 30 Nov 2004, Bruce Momjian wrote: Gavin, any chance of getting this patch against the HTML version, rather than the generated text version? It is in doc/src/FAQ/. --- Gavin Sherry wrote: Hi all, An initial look at bring the developer's FAQ up to date and reworking some text to make it more useful. Thanks, Gavin Content-Description: [ Attachment, skipping... ] ---(end of broadcast)--- TIP 4: Don't 'kill -9' the postmaster -- Bruce Momjian| http://candle.pha.pa.us [EMAIL PROTECTED] | (610) 359-1001 + If your life is a hard drive, | 13 Roberts Road + Christ can be your backup.| Newtown Square, Pennsylvania 19073 ---(end of broadcast)--- TIP 1: subscribe and unsubscribe commands go to [EMAIL PROTECTED]
[PATCHES] Developer's FAQ update
Hi all, An initial look at bring the developer's FAQ up to date and reworking some text to make it more useful. Thanks, Gavin# Old manifest: 2910f7d05f74e086c097595fe8cc78ad728474e4 # New manifest: f4a4fb1871edfc75efcfa80ade602e36463909f0 # Summary of changes: # # patch doc/FAQ_DEV #from 6ea09a083520481b8896b30432a85af841655f31 # to 4b017fc05c35d88807fc61a5d12767ac5838eecb # # patch src/backend/access/transam/xlog.c #from 44af82f3c379aad3d842fc2b903d0211ecdd1e30 # to 08dcb5592d1c8a9501dd6e8845c32b96710b987c # --- doc/FAQ_DEV +++ doc/FAQ_DEV @@ -12,18 +12,18 @@ General Questions 1.1) How do I get involved in PostgreSQL development? - 1.2) How do I add a feature or fix a bug? - 1.3) How do I download/update the current source tree? - 1.4) How do I test my changes? - 1.5) What tools are available for developers? - 1.6) What books are good for developers? - 1.7) What is configure all about? - 1.8) How do I add a new port? - 1.9) Why don't you use threads/raw devices/async-I/O, insert your + 1.2) How do I download/update the current source tree? + 1.3) How do I test my changes? + 1.4) What tools are available for developers? + 1.5) What books are good for developers? + 1.6) What is configure all about? + 1.7) How do I add a new port? + 1.8) Why don't you use threads/raw devices/async-I/O, insert your favorite wizz-bang feature here? - 1.10) How are RPM's packaged? - 1.11) How are CVS branches handled? - 1.12) Where can I get a copy of the SQL standards? + 1.9) How are RPMs packaged? + 1.10) How are CVS branches handled? + 1.11) Where can I get a copy of the SQL standards? + 1.12) Where can I get technical assistance? Technical Questions @@ -42,154 +42,144 @@ 1.1) How go I get involved in PostgreSQL development? - This was written by Lamar Owen: + 1.1.1) Where do I start? + + Download the code and have a look around. See 1.2. - 2001-06-22 - What open source development process is used by the PostgreSQL team? - - Read HACKERS for six months (or a full release cycle, whichever is - longer). Really. HACKERS _is_the process. The process is not well - documented (AFAIK -- it may be somewhere that I am not aware of) -- - and it changes continually. - What development environment (OS, system, compilers, etc) is required + Subscribe to and read the pgsql-hackers mailing list (often termed + 'hackers'). This is where the major contributors and core members of the + project discuss development. + + 1.1.2) What development environment (OS, system, compilers, etc) is required to develop code? - Developers Corner on the website has links to this information. The - distribution tarball itself includes all the extra tools and documents - that go beyond a good Unix-like development environment. In general, a - modern unix with a modern gcc, GNU make or equivalent, autoconf (of a - particular version), and good working knowledge of those tools are - required. - What areas need support? + PostgreSQL is developed mostly in the C programming language. It also + makes use of Yacc and Lex. + + The source code is targeted at most of the popular Unix platforms and + the Windows environment (XP, Windows 2000, and up). + + Most developers make use of the open source development tool chain which + you are probably familiar with if you've compiled or contributed to + open source software before. Developers using this tool chain on Windows + make use of MingW (see http://www.mingw.org/). + + 1.1.3) What areas need work? - The TODO list. + Outstanding features are detailed in the TODO list. This is located in + doc/TODO in the source distribution or at + http://developer.postgresql.org/todo.php. + + You can learn more about these features by consulting the archives, the + SQL standards and the recommend texts (see 1.6). + + 1.1.4) What do I do after choosing an item to work on? + + Send an email to pgsql-hackers with a proposal for what you want to do + (assuming your contribution is not trivial). Working in isolation is not + advisable: others may be working on the same TODO item; you may have + misunderstood the TODO item; your approach may benefit from the review of + others. + + 1.1.5) Where can I learn more about the code? + + Other than documentation in the source tree itself, you can find some + papers/presentations discussing the code at http://developers.postgresql.org + + 1.1.6) I've developed a patch, what next? + + Generate the patch in contextual diff format. If you are unfamiliar with + this, you may find the script src/tools/makediff/difforig useful. + + Ensure that your patch is generated against the most recent version of the + code.
