aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/books/developers-handbook/tools
Commit message (Collapse)AuthorAgeFilesLines
* doc: Update source files (en .po), for translationsEdson Brandi2025-06-291-2/+3
|
* developers-handbook: Correct command to build entire OSEd Maste2025-05-251-1/+1
| | | | | | | | | `make world` and `make buildworld` do not build the kernel, so to actually compile "the entire operating system" the appropriate command is `make buildworld buildkernel`. Reported by: olce Sponsored by: The FreeBSD Foundation
* docs: Remove references to `make world`Ed Maste2025-05-231-1/+1
| | | | | | | | | Two of these seemed to be used in the sense of "building the system." The other one was a literal command, but was incorrect. Reviewed by: jhb Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D50471
* doc: Update source files (en .po), for translationsDanilo G. Baio2025-05-011-462/+464
|
* [documentation]: Fix front matter "path" parameter.Fernando Apesteguía2025-02-181-1/+2
| | | | | | | | "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-291-424/+409
| | | | | | | | Via `sh tools/update_translate_template.sh documentation` Reviewed by: dbaio Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48234
* Fix links that use crossref without descriptionFernando Apesteguía2024-09-221-2/+2
| | | | | | | | | | | | | 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
* Update developer-handbook tools, remove deprecated portsOskar Holmlund2024-09-201-8/+3
| | | | | | | | | | | | | | | | | | | Remove lang/gcl https://www.freshports.org/lang/gcl remove lang/cmucl https://www.freshports.org/lang/cmucl Update perl version 5.24->5.36 Remove lang/icon https://www.freshports.org/lang/icon/ Update Lua version Reviewed by: Pau Amma, mhorne, manu Approved by: Pau Amma, manu(mentor) Differential Revision: https://reviews.freebsd.org/D46645
* doc: Update source files (en .po), for translationsDanilo G. Baio2024-09-141-421/+415
|
* [documentation]: Fix links in all output formatsFernando Apesteguía2024-09-071-3/+3
| | | | | | | | | | | | | 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
* developers-handbook: Remove reference to old FreeBSD versionEd Maste2024-06-261-1/+1
| | | | | | | | FreeBSD 10's EOL was long enough ago that we don't need to mention a specific version that switched from GCC to Clang; simply state that Clang is cc. Sponsored by: The FreeBSD Foundation
* developers-handbook: remove reference to removed lang/logoEd Maste2024-06-261-6/+0
| | | | Reported by: Pau Amma
* developers-handbook: mention Lua and fluaEd Maste2024-05-211-0/+7
| | | | | | Reviewed by: imp, bapt Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D45281
* developers-handbook/tools: Update Tcl package versionDanilo G. Baio2024-03-241-1/+1
| | | | | | | Tcl 8.5 has been deprecated. Reported by: https://github.com/Hermholtz Pull Request: https://github.com/freebsd/freebsd-doc/pull/315
* documentation: Adjust path variables for Hugo 0.123.X upgradeDanilo G. Baio2024-03-231-1/+1
| | | | | | | | These adjustments ensure menu and navigation will work fine with the recent changes. Reviewed by: fernape Differential Revision: https://reviews.freebsd.org/D44284
* dev-handbook/tools: fix Emacs reference URL and some grammarrilysh2024-02-241-2/+2
| | | | | | | | | | | | | | | 1. Currently the given link of Emacs tutorial is broken and outdated. Emacs 19 was released way before and the FTP server is also unavailable. As these links get out of date rather quickly, use the online reference URL instead. 2. Fix grammar, use present tense (to match "can") and remove "an". (e.g. ran -> run, an another -> another) Reviewed by: Mina Galić <freebsd@igalic.co>, dbaio Pull Request: https://github.com/freebsd/freebsd-doc/pull/332 Signed-off-by: rilysh <nightquick@proton.me>
* doc: Update source files (en .po), for translationsDanilo G. Baio2024-01-171-237/+233
|
* developers-handbook: tweak introduction to lldbMitchell Horne2023-10-231-8/+5
| | | | | | | | | | | All supported versions of FreeBSD ship with lldb, so we no longer need to mention FreeBSD version specifics. While here, make some small tweaks to this text. Reviewed by: carlavilla, emaste Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D42333
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-09-091-246/+229
|
* Developers Handboo: Tools, remove reference to pmakeSergio Carlavilla Delgado2023-08-271-10/+1
| | | | | PR: 252938 Submitted by: Alexis Praga <alexis.praga@proton.me>
* Developers handbook: Fix linkSergio Carlavilla Delgado2023-07-171-1/+1
| | | | | PR: 265132 Submitted by: grahamperrin@
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-04-201-2/+2
|
* AsciiDoc text replacement: non-escaped ' -- 'Graham Perrin2023-02-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#text-replacements notes that text replacement may occur where -- – is between two word characters, between a word character and a line boundary, or flanked by spaces. The replacement: — – an em dash. The ripgrep command below helped to identify two editions of the FreeBSD Developers' Handbook in which an escape charater was required. rg '`.* -- .*`' /usr/doc Whilst here: full stops, and one sentence per line for the affected subsection of the zh-tw translation of the book. https://bugs.freebsd.org/269679 PR: 269679 Pull request: https://github.com/freebsd/freebsd-doc/pull/113
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-01-211-8/+8
|
* Update ruby links in Developers HandbookKaíque Kandy Koga2023-01-081-1/+1
| | | | PR: 268777
* doc: Add source .po files for translationsDanilo G. Baio2022-08-071-0/+3377
| | | | | | | | | | | | | | | | | | 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
* developers-handbook/tools: Fix link to 12.make fileSohaib Mohamed2022-04-031-1/+1
| | | | | PR: 258980 Reviewed by: dbaio
* developers-handbook/tools: Fix subsection attributeDanilo G. Baio2022-01-081-1/+1
| | | | | | | | | | | | | | | | | | | The subsection in tools is the second and not 'A'. Chapter 2 - A.1 - A.2 - ... --> Chapter 2 - 2.1 - 2.2 - ... PR: 261016 Reported by: Pau Amma
* New Documentation PortalSergio Carlavilla Delgado2021-12-111-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-031-13/+26
| | | | | | | | | | | | | | | | | | | | | | * 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
* developers-handbook: correct gcc port categoryCeri Davies2021-07-221-1/+1
|
* developers-handbook/tools: update to reflect gcc exit from baseCeri Davies2021-06-291-79/+6
| | | | | | | Remove some FAQs which clang's warnings render pointless. Reported by: Faraz Vahedi <kfv@kfv.io> Differential Revision: https://reviews.freebsd.org/D25864
* Revert "Add Hugo's lang shortcode"Danilo G. Baio2021-06-191-3/+3
| | | | | | | 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-191-3/+3
| | | | | | | | | | | | | | | | | | 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
* Remove an extra space after '+' charactersDanilo G. Baio2021-06-081-4/+4
| | | | | | | | | | | | | 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
* Use One Sentence Per Line in the Developers HandbookSergio Carlavilla Delgado2021-06-061-126/+342
|
* Fix references to /usr/share and /usr/local/shareAllan Jude2021-05-151-4/+4
| | | | | | | | Somewhere during the documentation conversion, these were accidentally changed to /usr{,/local}/shared which is incorrect. Reported By: thj Sponsored By: Klara Inc.
* Improve SEO with the keywors meta tagSergio Carlavilla Delgado2021-05-041-0/+1
| | | | | | 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 the SEO of the documentation portalSergio Carlavilla Delgado2021-05-011-0/+1
| | | | | | | 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
* Split the developers handbookSergio Carlavilla Delgado2021-04-011-50/+50
|
* Use correct syntax markup for shellLi-Wen Hsu2021-03-141-47/+47
| | | | Approved by: carlavilla
* Multiple files: Fix 'shared' referencesCeri Davies2021-02-221-2/+2
| | | | | | | | The hier(7) man-page lists /usr/share as the location for architecture-independent files, so fix a few instances where the documentation referes to /usr/shared instead of /usr/share. PR: 253760
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-251-0/+1492
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-10-07 16:08:44 +0000