aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/books/arch-handbook
Commit message (Collapse)AuthorAgeFilesLines
* doc: Update source files (en .po), for translationsDanilo G. Baio2025-05-0121-3928/+3929
|
* [documentation]: Fix front matter "path" parameter.Fernando Apesteguía2025-02-1821-21/+42
| | | | | | | | "path:" parameter in the front matter was not documented and it has been deprecated in gohugo 0.144.0. Create a custom parameter with the same name in preparation for the upcoming update of www/gohugo to 0.144.1
* Regenerate translation filesEd Maste2024-12-293-9/+8
| | | | | | | | Via `sh tools/update_translate_template.sh documentation` Reviewed by: dbaio Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48234
* Arch Handbook - driver basics: Minor tweaksMark Linimon2024-12-291-1/+1
| | | | | Reviewed by: emaste@, carlavilla@, Pau Amma<pauamma@gundo.com> Pull Request: https://github.com/freebsd/freebsd-doc/pull/417
* Fix links that use crossref without descriptionFernando Apesteguía2024-09-222-3/+3
| | | | | | | | | | | | | Summary: Add the anchor text to the crossref macro Test Plan: Apply patch and build the documentation A follow-up change will make the crossref macro fail if no description is used. Subscribers: delphij Differential Revision: https://reviews.freebsd.org/D46721
* doc: Update source files (en .po), for translationsDanilo G. Baio2024-09-147-3413/+2666
|
* [documentation]: Fix links in all output formatsFernando Apesteguía2024-09-073-8/+19
| | | | | | | | | | | | | Use the crossref: macro for intra-file and intra-book links. This will produce the correct link in Single HTML, Splitted HTML and PDF. Rework the macro to include the PDF special render. While here, briefly document macros. PR: 266107 Reviewed by: bcr@, dbaio@, concussious.bugzilla_runbox.com Differential Revision: https://reviews.freebsd.org/D46480
* documentation: Fix all warningsFernando Apesteguía2024-08-201-1/+0
| | | | All warnings related to tables with unfinished rows.
* arch-handbook: rewrite MAC chapter K&R C prototypesEd Maste2024-07-281-954/+258
| | | | | | | | | K&R C has been deprecated for decades and is no longer valid C. Reported by: https://101010.pl/@nabijaczleweli/112860058280711119 Reviewed by: lwhsu Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D46171
* documentation: Adjust path variables for Hugo 0.123.X upgradeDanilo G. Baio2024-03-2320-20/+21
| | | | | | | | These adjustments ensure menu and navigation will work fine with the recent changes. Reviewed by: fernape Differential Revision: https://reviews.freebsd.org/D44284
* arch-handbook/driverbasics: use tabs to indent the example coderilysh2024-02-241-17/+17
| | | | | | | | | | | | | In the "Writing FreeBSD Device Drivers" page, the first example uses 2 characters (spaces) to indent the code. Since FreeBSD uses tabs (8 characters) to indent and as the second example also follows this, it's better to just use tabs here as well. Link: https://docs.freebsd.org/en/books/arch-handbook/driverbasics/ Reviewed by: Mina Galić <freebsd@igalic.co>, dbaio Pull Request: https://github.com/freebsd/freebsd-doc/pull/319 Signed-off-by: rilysh <nightquick@proton.me>
* arch-handbook/boot: Add missing space between phrasesrilysh2024-01-181-3/+5
| | | | | | Reviewed by: Mina Galić <freebsd@igalic.co> Pull Request: https://github.com/freebsd/freebsd-doc/pull/320 Signed-off-by: rilysh <nightquick@proton.me>
* arch-handbook/usb: Fix typo for USBShi-Xin Huang2024-01-181-1/+1
| | | | | | | | There's a missing space between "that" and "frame". Event: Advanced UNIX Programming Course (Fall’23) at NTHU Reviewed by: lwhsu Pull Request: https://github.com/freebsd/freebsd-doc/pull/322
* Books: Remove 'Copyright' repetitionSergio Carlavilla Delgado2023-10-011-1/+1
| | | | PR: 274182
* Bump some copyright yearsSergio Carlavilla Delgado2023-08-262-2/+2
|
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-05-211-2837/+2862
|
* vale/style: Utilize vales vocabulary engineMuhammad Moinur Rahman2023-05-041-625/+945
| | | | | | | | | | | | | | | | | | - Remove spelling-exceptions list - Vale has it's own engine to add custom vocabulary for adding project specific keywords. Add a vocabulary named Terms - Add the file accept.txt which words should be accepted without any errors - Utilize documentation/content/en/books/arch-handbook/mac/_index.adoc as proof of concept to remove all sort of errors/warnings/suggestion. - Remove EOLSpace - Fix Semantic Line Breakings - Add relevant keywords to the new Vocab file accept.txt - Some codewords were not marked with single tick ` so mark those properly that spelling engine do not throw errors Approved by: carlavilla (mentor) Differential Revision: https://reviews.freebsd.org/D39703
* arch_handbook: Fix copyright lineLorenzo Salvadore2023-03-051-1/+1
| | | | | | | | | | The copyright line was displayed as "Copyright © Copyright © 2000-2006, 2012-2021 The FreeBSD Documentation Project". Remove the extra "Copyright © ". Approved by: doceng (blanket)
* doc: Update source files (en .po), for translationsDanilo G. Baio2022-10-301-4/+4
|
* Fix two typos under Chapter 1 of the english FreeBSD architecture HandbookNicholas Sullivan2022-10-221-2/+2
| | | | Pull Request: https://github.com/freebsd/freebsd-doc/pull/89
* doc: Update source files (en .po), for translationsDanilo G. Baio2022-09-041-228/+220
|
* arch-handbook: BUS_DMA_ISA no longer existsColin Percival2022-09-031-2/+1
| | | | | | The BUS_DMA_ISA flag was removed in March 2008. Pull Request: https://github.com/freebsd/freebsd-doc/pull/83
* doc: Add source .po files for translationsDanilo G. Baio2022-08-0722-0/+25532
| | | | | | | | | | | | | | | | | | This helps the Weblate translation workflow and offline translations through .po files, it's important to update these files constantly. The goal here is to have a semi-automated translation workflow; Weblate will pull updates automatically from the main repository and commit translations to another repository. Doc committers are encouraged to update the source .po files whenever there are updates in the English documentation part. $ ./tools/update_translate_template.sh documentation Anyway, I'll keep doing this periodically. Discussed with: doceng
* arch-handbook: Fix a few nitsDaniel Ebdrup Jensen2022-04-181-3/+3
| | | | | | A couple of typos were noticed during the conversion to one sentence per line, and have now been corrected. While here, move a manual page reference into the same line as the sentence that refers to it.
* arch-handbook: Convert to one sentence per lineDaniel Ebdrup Jensen2022-04-181-130/+492
| | | | | | | | To make the file easier to change, and to be fully compatible with AsciiDoctor, this file has been converted to one sentence per line. A few minor nits were noticed, and will be corrected in a follow-up commit.
* arch-handbook: Update boot chapterIsa2022-04-181-233/+233
| | | | | | | | | | | | | | | | | | A lot has changed in the code since RELEASE 10.0 in 2014, when this document last received a major content change. One significant change is in the path to the boot folder, ie src/sys/boot has become src/stand/. Another change is that various code blocks have had their sample texts updated, such as the dmesg now looking like it does on a new install. Similarly, the assembly code has been updated with the relevant sections from the source tree. The spacing has been changed to be maximally compatible with the original version. Reviewed by: imp (src), Pau Amma <pauamma@gundo.com> Pull Request: https://github.com/freebsd/freebsd-doc/pull/60
* handbook/mirrors: Refresh sectionDanilo G. Baio2022-02-112-2/+2
| | | | | | | | | Remove mirrors sections with stale information in favor of a small and unified one. Reviewed by: pauamma_gundo.com, philip, trasz Approved by: philip (clusteradm) Differential Revision: https://reviews.freebsd.org/D34156
* documentation: Now download.freebsd.org has no /ftp/ in the pathLi-Wen Hsu2022-01-142-2/+2
| | | | Sponsored by: The FreeBSD Foundation
* arch-handbook/driverbasics: Fix example codeblitztide2022-01-111-2/+2
| | | | | | | | | The driver code does not compile as it includes sys/module.h before sys/param.h. PR: 261014 Reviewed by: allanjude Pull Request: https://github.com/freebsd/freebsd-doc/pull/50
* New Documentation PortalSergio Carlavilla Delgado2021-12-1123-63/+67
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-0322-229/+459
| | | | | | | | | | | | | | | | | | | | | | * Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
* books: Sync front matter between Split and Single pageDanilo G. Baio2021-07-112-3/+4
|
* doc: Add links for Split and Single HTML pagesDanilo G. Baio2021-07-112-0/+2
| | | | | | | | | | | | | [ Split HTML / Single HTML ] We have this only for the biggest books. They have this option of single or split pages, but currently, it's shown for users just the split pages without the link to the single HTML. This is an option we had before. Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D31147
* Revert "Add Hugo's lang shortcode"Danilo G. Baio2021-06-1919-69/+69
| | | | | | | This reverts commit 3462d12db6ebf303064db168a2333374344f369a. Too soon, it broke asciidoctor-pdf which doesn't know Hugo's shortcode. It will take more time and care.
* Add Hugo's lang shortcodeDanilo G. Baio2021-06-1919-69/+69
| | | | | | | | | | | | | | | | | | This is a prerequisite for the translation workflow through .po files and Weblate. The asciidoctor include with the shortcode variable will help because won't be needed to change the includes manually after converting the translation (.po file) back to .adoc. It will help other areas like, language attributes, which today is fixed in every document. The use of shortcode was suggested by jmooring@ from Hugo's project on Github. Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30823
* arch-handbook/scsi: Preen formattingWarner Losh2021-06-181-230/+223
| | | | | | | | | | | | | | | | | | | | | Go through and fix the bits that the automatic conversion from docbook got wrong (and/or were wrong before). o Use [programlisting] for the xxx_ routine declarations o Un-nest the level of bullet points: make the outer ones sections or subsections o get the proper nesting for bits defined in some flags (they were in some places at the same level) o Minor code style preening to make thigns a little closer to style(9) since the examples used differing style. o Add subsection marking to a few places that didn't get converted to bullet points, but should have been. No actual content changes (yet), apart from the new sections. This document is somewhat out of date in places and needs to be modernized around locking, synchronization and a few short-cut APIs that used to need to be spelled out longhand. All that will be in followup commits. Sponsored by: Netflix
* arch-handbook: reformat scsi chapter one sentence per line before editing.Warner Losh2021-06-181-74/+227
|
* Remove an extra space after '+' charactersDanilo G. Baio2021-06-084-77/+77
| | | | | | | | | | | | | This is happening only on documentation/, basically in all places that attaches a block or a paragraph to a list [1]. Although this is working, it impacts our translation tool po4a, the '+' character is a difficult part when processing asciidoc[tor] files. 1 - https://docs.asciidoctor.org/asciidoc/latest/lists/continuation/#list-continuation Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30688
* Remove stray }Warner Losh2021-06-031-2/+1
| | | | | Noticed by: ceri@ Sponsored by: Netflix
* arch-handbook: Document PROLOG and EPILOGWarner Losh2021-05-311-1/+4
| | | | | | | | PROLOG and EPILOG modifiers are used to set code to insert before or after the method is called. It's use cases are limited. It is intended to only be used only for tracing or other profling. Sponsored by: Netflix
* arch-handbook: Document kobj HEADER keywordWarner Losh2021-05-311-1/+15
| | | | | | | The HEADER keyword is like the CODE keyword, except the lines go into the .h file. Sponsored by: Netflix
* Improve SEO with the keywors meta tagSergio Carlavilla Delgado2021-05-0419-23/+39
| | | | | | Add in all articles and books the tag list. Modify the theme to use the tag list defined in articles and books to generate the keywords meta tag
* Improve descriptions for some books and articlesAllan Jude2021-05-021-1/+2
| | | | | | | | | | Also add weights to some, to define the sort order in the index Put the more commonly used items at the top of their respective lists The improved descriptions were taken from the old books/articles list: https://www.freebsd.org/docs/books/ Sponsored-By: Klara Inc.
* Improve the SEO of the documentation portalSergio Carlavilla Delgado2021-05-0119-19/+36
| | | | | | | Changes: - Add the description meta tag in the index, articles and books - Add a brief description in each article and book. - Remove the SVN expansion tag
* kobj: Use one sentence per lineWarner Losh2021-04-261-13/+44
| | | | | | | In advance of updating this chapter, go through and make it one sentence per line. No content changes. Sponsored by: Netflix
* Split Arch HandbookSergio Carlavilla Delgado2021-03-3123-69/+159
| | | | Split the porters handbook into different chapters like the handbook
* Use correct syntax markup for shellLi-Wen Hsu2021-03-142-8/+8
| | | | Approved by: carlavilla
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-2519-0/+12751
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
generated by cgit v1.2.3 (git 2.25.1) at 2025-09-26 02:11:09 +0000