Path: blob/main/documentation/content/en/books/fdp-primer/working-copy/_index.po
18099 views
# SOME DESCRIPTIVE TITLE # Copyright (C) YEAR The FreeBSD Project # This file is distributed under the same license as the FreeBSD Documentation package. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" "POT-Creation-Date: 2025-05-01 19:56-0300\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <[email protected]>\n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. type: YAML Front Matter: description #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:1 #, no-wrap msgid "How to get a working copy of the FreeBSD Documentation Project" msgstr "" #. type: YAML Front Matter: title #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:1 #, no-wrap msgid "Chapter 3. The Working Copy" msgstr "" #. type: Title = #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:14 #, no-wrap msgid "The Working Copy" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:53 msgid "" "The _working copy_ is a copy of the FreeBSD repository documentation tree " "downloaded onto the local computer. Changes are made to the local working " "copy, tested, and then submitted as patches to be committed to the main " "repository." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:56 msgid "" "A full copy of the documentation tree can occupy 550 megabytes of disk " "space. Allow for a full gigabyte of space to have room for temporary files " "and test versions of various output formats." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:59 msgid "" "link:https://git-scm.com/[Git] is used to manage the FreeBSD documentation " "files. It is obtained by installing the package:devel/git[] package, which " "also has a lighter flavor called git-lite:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:63 #, no-wrap msgid "# pkg install git-lite\n" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:66 #, no-wrap msgid "Documentation and Manual Pages" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:72 msgid "" "FreeBSD documentation is not just books and articles. Manual pages for all " "the commands and configuration files are also part of the documentation, and " "part of the FDP's territory. Two repositories are involved: `doc` for the " "books and articles, and `src` for the operating system and manual pages. To " "edit manual pages, the `src` repository must be checked out separately." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:75 msgid "" "Repositories may contain multiple versions of documentation and source " "code. New modifications are almost always made only to the latest version, " "called `main`." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:77 #, no-wrap msgid "Choosing a Directory" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:82 msgid "" "FreeBSD documentation is traditionally stored in [.filename]#/usr/doc/#, and " "system source code with manual pages in [.filename]#/usr/src/#. These " "directory trees are relocatable, and users may want to put the working " "copies in other locations to avoid interfering with existing information in " "the main directories. The examples that follow use [.filename]#~/doc# and " "[.filename]#~/src#, both subdirectories of the user's home directory." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:84 #, no-wrap msgid "Checking Out a Copy" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:88 msgid "" "A download of a working copy from the repository is called a _clone_, and " "done with `git clone`. This example clones a copy of the latest version " "(`main`) of the main documentation tree:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:92 #, no-wrap msgid "% git clone https://git.FreeBSD.org/doc.git ~/doc\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:95 msgid "A checkout of the source code to work on manual pages is very similar:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:99 #, no-wrap msgid "% git clone https://git.FreeBSD.org/src.git ~/src\n" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:102 #, no-wrap msgid "Updating a Working Copy" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:108 msgid "" "The documents and files in the FreeBSD repository change daily. People " "modify files and commit changes frequently. Even a short time after an " "initial checkout, there will already be differences between the local " "working copy and the main FreeBSD repository. To update the local version " "with the changes that have been made to the main repository, use `git pull` " "on the directory containing the local working copy:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:113 #, no-wrap msgid "" "% cd ~/doc\n" "% git pull --ff-only\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:118 msgid "" "Get in the protective habit of using `git pull` before editing document " "files. Someone else may have edited that file very recently, and the local " "working copy will not include the latest changes until it has been updated. " "Editing the newest version of a file is much easier than trying to combine " "an older, edited local file with the newer version from the repository." msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:120 #, no-wrap msgid "Reverting Changes" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:125 msgid "" "Sometimes it turns out that changes were not necessary after all, or the " "writer just wants to start over. Files can be \"reset\" to their unchanged " "form with `git restore`. For example, to erase the edits made to " "[.filename]#_index.adoc# and reset it to unmodified form:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:129 #, no-wrap msgid "% git restore _index.adoc\n" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:132 #, no-wrap msgid "Making a Diff" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:136 msgid "" "After edits to a file or group of files are completed, the differences " "between the local working copy and the version on the FreeBSD repository " "must be collected into a single file for submission. These _diff_ files are " "produced by redirecting the output of `git diff` into a file:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:141 #, no-wrap msgid "" "% cd ~/doc\n" "% git diff > doc-fix-spelling.diff\n" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:145 msgid "" "Give the file a meaningful name that identifies the contents. The example " "above is for spelling fixes to the whole documentation tree." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:147 msgid "" "If the diff file is to be submitted with the web \"link:https://" "bugs.FreeBSD.org/bugzilla/enter_bug.cgi[Submit a FreeBSD problem report]\" " "interface, add a [.filename]#.txt# extension to give the earnest and simple-" "minded web form a clue that the contents are plain text." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:150 msgid "" "Be careful: `git diff` includes all changes made in the current directory " "and any subdirectories. If there are files in the working copy with edits " "that are not ready to be submitted yet, provide a list of only the files " "that are to be included:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:155 #, no-wrap msgid "" "% cd ~/doc\n" "% git diff disks/_index.adoc printers/_index.adoc > disks-printers.diff\n" msgstr "" #. type: Title == #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:158 #, no-wrap msgid "Git References" msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:161 msgid "" "These examples show very basic usage of Git. More detail is available in " "the https://git-scm.com/book/en/v2[Git Book] and the https://git-scm.com/" "doc[Git documentation]." msgstr ""