summaryrefslogtreecommitdiff
path: root/HACKING
AgeCommit message (Collapse)Author
2018-05-14Remove all modelines from the projectEli Schwartz
Many of these are pointless (e.g. there is no need to explicitly turn on spellchecking and language dictionaries for the manpages by default). The only useful modelines are the ones enforcing the project coding standards for indentation style (and "maybe" filetype/syntax, but everything except the asciidoc manpages and makepkg.conf is already autodetected), and indent style can be applied more easily with .editorconfig Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> Signed-off-by: Allan McRae <allan@archlinux.org>
2015-10-21HACKING: Allow the use of 'sizeof' on valuesPierre Neidhardt
Signed-off-by: Pierre Neidhardt <ambrevar@gmail.com> Signed-off-by: Allan McRae <allan@archlinux.org>
2014-01-28HACKING: mention tab size and line widthAllan McRae
Signed-off-by: Allan McRae <allan@archlinux.org>
2014-01-28Remove ts and sw from vim modeline when noet is setFlorian Pritz
Forcing vim users to view files with a tabstop of 2 seems really unnecessary when noet is set. I find it much easier to read code with ts=4 and I dislike having to override the modeline by hand. Command run: find . -type f -exec sed -i '/vim.* noet/s# ts=2 sw=2##' {} + Signed-off-by: Florian Pritz <bluewind@xinu.at> Signed-off-by: Allan McRae <allan@archlinux.org>
2013-11-08Use title case for a heading in HACKING; fix capitalization of "Vim" in HACKINGJason St. John
Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Allan McRae <allan@archlinux.org>
2013-01-04Fix spacing in HACKING spacing exampleAllan McRae
Signed-off-by: Allan McRae <allan@archlinux.org>
2012-08-07added coding standardBarbu Paul - Gheorghe
Signed-off-by: Barbu Paul - Gheorghe <barbu.paul.gheorghe@gmail.com>
2011-12-21include config.h via MakefilesDave Reisner
Ensures that config.h is always ordered correctly (first) in the includes. Also means that new source files get this for free without having to remember to add it. We opt for -imacros over -include as its more portable, and the added constraint by -imacros doesn't bother us for config.h. This also touches the HACKING file to remove the explicit mention of config.h as part of the includes. Signed-off-by: Dave Reisner <dreisner@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
2011-12-21Add note to HACKING about operator spacingDan McGee
2011-07-28Unify modelines in Asciidoc filesDan McGee
This gets us close to using the same modeline in all files we run through Asciidoc, as well as adding the spell and spelllang declarations, just as we had in NEWS already. The choice of 'en_us' is mainly for consistency and because the body of work already uses these spellings. Signed-off-by: Dan McGee <dan@archlinux.org>
2011-03-20Style change: return(x) --> return xDan McGee
This was discussed and more or less agreed upon on the mailing list. A huge checkin, but if we just do it and let people adjust the pain will end soon enough. Rebasing should be relatively straighforward for anyone that sees conflicts; just be sure you use the new return style if possible. The following semantic patch was used to do the change, along with some hand-massaging in order to preserve parenthesis where appropriate: The semantic match that finds this problem is as follows, although some hand-massaging was done in order to keep parenthesis where appropriate: (http://coccinelle.lip6.fr/) // <smpl> @@ expression a; @@ - return(a); + return a; // </smpl> A macros_file was also provided with the following content: Additional steps taken, mainly for ASSERT() macros: $ sed -i -e 's#return(NULL)#return NULL#' lib/libalpm/*.c $ sed -i -e 's#return(-1)#return -1#' lib/libalpm/*.c Signed-off-by: Dan McGee <dan@archlinux.org>
2010-07-02Fix some incorrect asciidoc syntaxDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2009-11-15HACKING: add some notes about valgrind/gdb usageDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-08-23fix HACKING asciidoc file.Xavier Chantry
The HACKING file seemed to be broken : http://archlinux.org/pacman/HACKING.html And indeed, running asciidoc HACKING issued a number of warnings : WARNING: HACKING: line 27: missing [paradef-default] C-style entry type: numbered : expected 1 got 3 WARNING: HACKING: line 44: list item 3 out of sequence WARNING: HACKING: line 49: missing [paradef-default] C-style entry type: numbered : expected 2 got 4 WARNING: HACKING: line 62: list item 4 out of sequence type: numbered : expected 3 got 5 WARNING: HACKING: line 69: list item 5 out of sequence type: numbered : expected 4 got 6 WARNING: HACKING: line 75: list item 6 out of sequence type: numbered : expected 5 got 7 WARNING: HACKING: line 83: list item 7 out of sequence WARNING: HACKING: line 104: missing [paradef-default] C-style entry WARNING: HACKING: line 116: missing [paradef-default] C-style entry WARNING: HACKING: line 126: missing [paradef-default] C-style entry I just followed the syntax example there : http://www.methods.co.nz/asciidoc/userguide.html#X56 And all is fine now :) Signed-off-by: Xavier Chantry <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-06Asciidoc a few more of our informative filesDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-20Turn HACKING into an asciidoc documentDan McGee
Add some hints so we can use asciidoc on the HACKING document. It is still readable as text, but a simple 'asciidoc HACKING' command will give you a nice pretty guide now. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-19Spruce up HACKING a bitDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-05This commit looks much more monumental than it is. Almost all just #includeDan McGee
reordering and adding ones that were forgotten (noticed when trying to compile after reordering). * Updated the HACKING file to include information on #include usage. * print -> vprint in "making dir" function in pactest.
2007-02-26* Added a small note to HACKINGAaron Griffin
* Moved re-pacman to contrib/ as it's probably not as useful as the other stuff in scripts/
2007-02-20Thought about adding this a while back, finally remembered it. Basically a ↵Dan McGee
copy of the pacman-coding.html document in text form.