aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/developers-handbook
Commit message (Collapse)AuthorAgeFilesLines
* books/: Address more instances of sentences beginning with 'Because...'Ceri Davies2021-01-124-8/+8
| | | | | | | | | | | | | | As was the case with the previous commit, the intention is to avoid sentence fragments as well as sentences that can be mistaken for them, since the handbook isn't written in a style that makes use of subordinate conjunctions. While touching the relevant files, I also fixed a few issues pointed out by PauAmma, and reflowed a sentence as a result. PR: 252519 Submitted by: ceri@ Reviewed by: PauAmma
* handbook: add a section on remote debugging via LLDBGuangyuan Yang2020-12-281-0/+42
| | | | | | | | | | PR: 251709 Obtained from: Moritz Systems Submitted by: Michał Górny <mgorny@moritz.systems> Sponsored by: The FreeBSD Foundation Reviewed by: bcr Discussed with: dim, emaste Differential Revision: https://reviews.freebsd.org/D27524
* Remove a redundant sentence stop from a table entryBenedict Reuschling2020-07-241-1/+1
| | | | | | | | | | | for consistency. Submitted by: kfv_irbug.org Approved by: bcr Differential Revision: https://reviews.freebsd.org/D25786 Notes: svn path=/head/; revision=54372
* Update the debugging section to include lldb as well.Benedict Reuschling2020-06-152-93/+409
| | | | | | | | | | | | | | | | | | | | | | | | | | | Clean up the sections a bit to distinguish the two available debuggers (gdb and llvm). This includes giving the existing gdb sections a title that ends in "with gdb". The existing gdb section were grouped together into a new "Using gdb" section and moved up one section level (sect3 to sect2). A new section "Introduction to available debuggers" introduces and distinguishes gbd and lldb. Insert a new "Using lldb" section after the introduction, using the same structure and example code as the gdb section to ease comparison between the two compilers. An earlier reference to gdb is replaced by a generic debugger reference. Include the neccessary whitespace changes. On top of that, update copyright years of the developers-handbook. Thanks to Pau Amma for his diligent work on the patch and incorporating our feedback from the review! Submitted by: pauamma_gundo.com Reviewed by: debdrup, woodsb02, emaste, bcr Approved by: bcr Differential Revision: https://reviews.freebsd.org/D25139 Notes: svn path=/head/; revision=54255
* [website] Update projects section:Sergio Carlavilla Delgado2020-05-021-1/+1
| | | | | | | | | | | Removed busdma and netpert projects from the website and all of the references to their pages. Reviewed by: imp@, bcr@ Differential Revision: https://reviews.freebsd.org/D24619 Notes: svn path=/head/; revision=54090
* [website] Update projects section:Sergio Carlavilla Delgado2020-05-021-2/+1
| | | | | | | | | | | Removed busdma and netpert projects from the website and all of the references to their pages. Reviewed by: imp@, bcr@ Differential Revision: https://reviews.freebsd.org/D24619 Notes: svn path=/head/; revision=54089
* fiathd(8) and faith(4) were removed in r274331. Catch up to src andCy Schubert2020-04-201-34/+0
| | | | | | | | | | | remove their documentation in the developers handbook. Reviewed by: bcr Approved by: bcr Differential Revision: https://reviews.freebsd.org/D24509 Notes: svn path=/head/; revision=54064
* Use "^" refer to the base URL of the SVN repository.Brooks Davis2019-12-201-7/+7
| | | | | | | | | | Subversion has supported this syntax for many years. Reviewed by: bcr Differential Revision: https://reviews.freebsd.org/D21949 Notes: svn path=/head/; revision=53701
* Mass cleanup of textproc/igor warnings including:Benedict Reuschling2019-09-081-3623/+2875
| | | | | | | | | | | | | - use two spaces at sentence start - space before content - wrap long line - start content on same line - straggling <tag> - put listing on same line - add blank line after <tag> on previous line Notes: svn path=/head/; revision=53386
* Correct errors reported by textproc/igor:Benedict Reuschling2018-08-261-606/+576
| | | | | | | | | | - wrap long lines - add two spaces after a sentence stop - use tabs instead of spaces - bad tag indent Notes: svn path=/head/; revision=52177
* Fix errors reported by textproc/igor:Benedict Reuschling2018-08-261-863/+975
| | | | | | | | | | | - wrap long lines - add blank lines after <title> tags - use tabs instead of spaces - use two spaces at sentence start - Capitalization in title tags (where appropriate) Notes: svn path=/head/; revision=52175
* Rewrapping, putting commas after i.e., minor fixes that textproc/igor wasBenedict Reuschling2018-08-172-736/+613
| | | | | | | emitting. Notes: svn path=/head/; revision=52145
* Cleanup this file:Benedict Reuschling2018-08-161-317/+312
| | | | | | | | | - wrap overlong lines - proper indentation of elements - capitalization in title tags Notes: svn path=/head/; revision=52141
* Remove the last vestiges of overlong lines from this file to makeBenedict Reuschling2018-08-161-10/+18
| | | | | | | textproc/igor shut up about them. Notes: svn path=/head/; revision=52139
* Wrap the last few remaining overlong lines in this file to make textproc/igorBenedict Reuschling2018-08-161-10/+13
| | | | | | | completely happy with it. Notes: svn path=/head/; revision=52138
* Developer's handbook: bump some version numbersEitan Adler2018-06-301-3/+3
| | | | | | | | This entire section needs some TLC but give it some quick help by pointing to newer versions of software we talk about. Notes: svn path=/head/; revision=51939
* Developer's handbook: remove games/ referenceEitan Adler2018-06-302-6/+2
| | | | | | | | | We no longer have a separate games directory, so remove the explanation of it. Bump copyright year. Notes: svn path=/head/; revision=51938
* Various updates to the kernel debugging chapter.John Baldwin2018-04-181-218/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Document vmcore.last and describe it as the way to find the most recent dump rather than the highest numbered dump. - Document crashinfo and that it automatically runs to generate a core.txt.N file if core dumps are enabled in rc.conf. - Add a section on testing kernel dumps via the debug.kdb.panic sysctl. Remove a later note about debug.kdb.panic from the DDB section. - Remove any mention of gdb -k (for pre 5-3 kernels) and just talk about kgdb. - Remove paragraph that talks about trying to find the kernel.debug file. Instead, recommand 'kgdb -n <N>' which does this lookup automatically, and specifically recommend 'kgb -n last' to open the most recent crash dump. Mention the fallback of specifying the kernel and vmcore directly if needed. - Remove example dump from FreeBSD 2. It is generally no longer relevant. It used gdb -k which uses a different stack trace format as well as including a 'frame' command that doesn't existing kgdb. (kgdb instead lets you switch to different threads and processes). - Remove mention of old boot blocks that don't load debug symbols. I think this was last relevant in FreeBSD 2.x or 3.x. - Rework the description of 'boot -d' to assume the boot menu and explicitly mention 'boot -d' at the loader prompt. - Document how to get stack traces of other threads in DDB. - Fix a few references to gdb to reference kgdb instead. - Replace 'call cpu_reset' with 'reset' for DDB. Differential Revision: https://reviews.freebsd.org/D14711 Notes: svn path=/head/; revision=51572
* Update kgdb instructionsBenjamin Kaduk2018-03-091-3/+9
| | | | | | | | | | | | The port/package should be used now, and build system changes have moved the kernel images in the object tree to a new location (on newer systems) PR: 226015 Submitted by: Phil Eaton <philneaton95@gmail.com> Notes: svn path=/head/; revision=51474
* Move up the correct way to compile the kernelEitan Adler2017-10-291-27/+11
| | | | | | | | | | This makes the correct way more prominent. Also removes references to FreeBSD 4.x Reviewed By: allanjude Notes: svn path=/head/; revision=51152
* change download links from ftp to download.freebsd.orgWolfram Schneider2017-10-011-1/+1
| | | | | | | PR: 222678 Notes: svn path=/head/; revision=51016
* switch to HTTPSWolfram Schneider2017-09-291-2/+2
| | | | Notes: svn path=/head/; revision=50967
* Fix some extra spacing in screen entries.Mathieu Arnold2017-09-072-58/+32
| | | | | | | | | While there, replace some with programlisting when more suited. Sponsored by: Absolight Notes: svn path=/head/; revision=50805
* Site hosting "How do I write "Hello, world" in FreeBSD assembler" is no ↵Sevan Janiyan2017-08-111-2/+2
| | | | | | | | | | | | | | longer around. Switch to archive.org mirror. PR: 203346 Submitted by: <luoh2 AT rpi DOT edu> Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D11849 Notes: svn path=/head/; revision=50660
* Bump the copyright year for the Developers' Handbook following r50127.Glen Barber2017-05-251-0/+3
| | | | | | | Sponsored by: The FreeBSD Foundation Notes: svn path=/head/; revision=50284
* We point to broken CGI script which redirects to Amazon if working.Sevan Janiyan2017-04-041-1/+1
| | | | | | | | | | | | Replace link with the target Amazon URL visitor would be redirected to normally. PR: 218071 Submitted by: Ian A Rios <riosi AT rpi edu> Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D10259 Notes: svn path=/head/; revision=50127
* Rewrap long lineBenjamin Kaduk2016-10-051-2/+2
| | | | | | | Whitespace-only; translators can ignore. Notes: svn path=/head/; revision=49455
* Fix an incomplete sentence in the (rather unloved) developers handbookBenjamin Kaduk2016-10-051-2/+2
| | | | | | | | PR: 213200 Reported by: georgc7@rpi.edu Notes: svn path=/head/; revision=49454
* Document tests/ per hier(7) in src in the Developer's Handbook IntroductionEnji Cooper2016-06-111-0/+5
| | | | | | | | | | | | | | | | chapter Information about the tests/ directory was added to hier(7) in src@r250604. This is a follow up commit which documents its existence in ^/stable/10 and ^/head Approved by: hrs Differential Revision: https://reviews.freebsd.org/D6821 Reviewed by: hrs Notes: svn path=/head/; revision=48919
* Rewrite my previous change to use a <variablelist>. That way, it is muchBenedict Reuschling2016-04-241-9/+34
| | | | | | | | | | | clearer to understand and easier to read than having it all in one long sentence. Suggested by: wblock@ Sponsored by: Essen Hackathon 2016 Notes: svn path=/head/; revision=48734
* Replace some colons in a long sentence withBenedict Reuschling2016-04-241-2/+2
| | | | | | | | | | | | semi-colons to make a list which contains regular commas more readable. PR: 203345 Submitted by: munshs@rpi.edu Sponsored by: Essen Hackathon 2016 Notes: svn path=/head/; revision=48725
* - favor American English spelling of behaviorJason Helfman2016-03-271-1/+1
| | | | Notes: svn path=/head/; revision=48482
* - fix index spelling of Von NeumannJason Helfman2016-02-221-1/+1
| | | | | | | | | | PR: 207354 Submitted by: aleung013@gmail.com Approved by: wblock (mentor) Differential Revision: https://reviews.freebsd.org/D5377 Notes: svn path=/head/; revision=48240
* - address spelling issueJason Helfman2016-02-191-1/+1
| | | | | | | | | | PR: 207354 Submitted by: aleung013@gmail.com Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D5354 Notes: svn path=/head/; revision=48203
* Replace gcc with clang to keep consistent with section 2.5.1Kevin Lo2015-12-231-2/+2
| | | | | | | | Submitted by: Ruey-Cherng Yu <raycherng at gmail.com> Differential Revision: https://reviews.freebsd.org/D4678 Notes: svn path=/head/; revision=47902
* - cleanup wording in developer's handbookJason Helfman2015-10-051-3/+2
| | | | | | | | | | PR: 203441 (based on) Submitted by: egreaves3@gmail.com Approved by: bcr@ (mentor) Differential Revision: https://reviews.freebsd.org/D3821 Notes: svn path=/head/; revision=47513
* Remove a broken link from the developers handbookAllan Jude2015-09-281-2/+2
| | | | | | | | | | PR: 202249 Submitted by: pfg (original) Approved by: bcr (mentor) Sponsored by: EuroBSDCon DevSummit Notes: svn path=/head/; revision=47454
* Clean up some of the formatting in the rendered version.Brad Davis2015-04-131-10/+6
| | | | Notes: svn path=/head/; revision=46528
* Don't encourage people to add '.' to path. This can lead to subtleEitan Adler2015-04-011-13/+2
| | | | | | | issues in many common configurations. Notes: svn path=/head/; revision=46406
* Wrap lines, spacing nits, etc. following previous change.Glen Barber2015-03-121-14/+13
| | | | | | | | | Translators please ignore. Sponsored by: The FreeBSD Foundation Notes: svn path=/head/; revision=46337
* Fix a few grammatical nits.Glen Barber2015-03-121-14/+17
| | | | | | | | | | | | | Change wording referencing the previous section of the kerneldebug book. Reword the 'Add these options' sentence. Consistify spacing in the KERNCONF addition list. Fix a typo. Sponsored by: The FreeBSD Foundation Notes: svn path=/head/; revision=46336
* Add missing </para>Eitan Adler2014-06-301-1/+1
| | | | Notes: svn path=/head/; revision=45178
* Bump copyrightEitan Adler2014-06-301-0/+1
| | | | Notes: svn path=/head/; revision=45177
* Don't make it seem like FreeSBD lacks these interfaces when firstEitan Adler2014-06-301-9/+3
| | | | | | | reading the sentence. Notes: svn path=/head/; revision=45176
* Eliminate some history from the documentation.Eitan Adler2014-06-301-24/+6
| | | | Notes: svn path=/head/; revision=45175
* Restore lost <replaceable> tags.Warren Block2014-04-287-48/+48
| | | | Notes: svn path=/head/; revision=44678
* Add WITNESS_SKIPSPIN to the list of kernel debugging optionsGlen Barber2014-01-121-0/+1
| | | | | | | | | | that should be enabled. Reviewed by: sbruno (earlier version), kib Sponsored by: The FreeBSD Foundation Notes: svn path=/head/; revision=43475
* Normalize DTD URL.Hiroki Sato2013-11-131-1/+1
| | | | Notes: svn path=/head/; revision=43184
* - Definitively upgrade to DocBook 5.0Gabor Kovesdan2013-11-0712-655/+470
| | | | Notes: svn path=/projects/db5/; revision=43125
* MFHGabor Kovesdan2013-11-051-1/+4
|\ | | | | | | Notes: svn path=/projects/db5/; revision=43105