[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Fixed some typos and broken links in CG
From: |
pls |
Subject: |
Fixed some typos and broken links in CG |
Date: |
Sun, 01 Nov 2015 17:51:18 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/25.0.50 (gnu/linux) |
Hey all,
here is a patch:
>From f7aff314562a1dfa709cef8923ddf1266b9e5a41 Mon Sep 17 00:00:00 2001
From: pls <address@hidden>
Date: Sun, 1 Nov 2015 17:40:03 +0100
Subject: [PATCH] Fixed some typos and links.
---
Documentation/contributor/administration.itexi | 15 ++++++-----
Documentation/contributor/doc-work.itexi | 6 ++---
Documentation/contributor/introduction.itexi | 8 +++---
Documentation/contributor/quick-start.itexi | 26 ++++++++-----------
Documentation/contributor/source-code.itexi | 35 ++++++++++----------------
Documentation/included/compile.itexi | 30 +++++++++++-----------
Documentation/included/helpus.itexi | 3 +--
7 files changed, 53 insertions(+), 70 deletions(-)
diff --git a/Documentation/contributor/administration.itexi
b/Documentation/contributor/administration.itexi
index 5420b04..ed9b599 100644
--- a/Documentation/contributor/administration.itexi
+++ b/Documentation/contributor/administration.itexi
@@ -174,7 +174,7 @@ unsuccessful) operation. This is not a requirement and is
turned off
by default.
@c Need to explain in more detail how to set up Patchy for email but
address@hidden as I don't use myself it I have no experience - JL
address@hidden as I don't use it myself I have no experience - JL
@node Patchy requirements
@@ -289,7 +289,7 @@ build_dir = /tmp/lilypond-autobuild/
@end itemize
-The script creates a clones of @code{staging} and @code{master}
+The script creates clones of @code{staging} and @code{master}
branches (prefixed with @code{test-}) with a third branch, called
@code{test-master-lock} used as a check to protect against two or more
instances of Patchy being run locally at the same time.
@@ -762,7 +762,7 @@ suggested in a different proposal), this proposal may
become moot.
(prep: 1 hour. discuss: 5 hours)
@item @strong{initalizer lists}:
-shoudl we use initalizer lists for C++? AFAIK they make no
+should we use initalizer lists for C++? AFAIK they make no
difference for built-in types, but there's some weird case where
it's more efficient for objects, or something.
@@ -904,7 +904,7 @@ different formatting styles.
But whatever style you use, please use it consistently, since a
mixture of styles within one program tends to look ugly. If you
are contributing changes to an existing program, please follow the
-style of that program.
+style of that program.
@end quotation
(@uref{http://www.gnu.org/prep/standards/html_node/Formatting.html})
@@ -979,7 +979,7 @@ weeks (BLUE)
@end multitable
@c A graphical display of bugs:
address@hidden
address@hidden
@c @image{bugs-2.13-visualization,png}
@c @image{zoom-2.13-visualization,png}
@@ -1333,7 +1333,7 @@ before proceeding to the next stage.
This will be done by starting from individual lilypond calls
within lilypond-book, and slowly moving to @qq{larger} targets of
-the build system -- after the individual lilypond calls are are
+the build system -- after the individual lilypond calls are
producing the appropriate amount of output and this is saved in
the right place and we can automatically isolate parts of a
failing build, we will work on lilypond-book in general, and only
@@ -1408,7 +1408,7 @@ Once this is finished, we will release lilypond 3.0.
@subheading The Problem
One of the biggest complaints people have with lilypond -- other
-than silly thing like "there's no gui" -- is the changing syntax.
+than silly things like "there's no gui" -- is the changing syntax.
Now, inventing a language or standards is difficult. If you set
it in stone too soon, you risk being stuck with decisions which
may limit matters. If you keep on updating the syntax,
@@ -1750,4 +1750,3 @@ record of patches being accepted without problems. If
existing
developers are tired of pushing patches for a contributor, we'll
discuss giving them push access. Unsolicited requests from
contributors for access will almost always be turned down.
-
diff --git a/Documentation/contributor/doc-work.itexi
b/Documentation/contributor/doc-work.itexi
index 70fd226..48b75dc 100644
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -195,7 +195,7 @@ have the @qq{docs} tag can then be easily added as a
automatically in the Snippets lists. See @ref{Introduction to LSR}.
Snippets that @emph{don't} have the @qq{docs} tag will still be
-searchable and viewable within the LSR, but will be not be included in
+searchable and viewable within the LSR, but will not be included in
the Snippets list or be able to be included as part of the main
documentation.
@@ -516,7 +516,7 @@ excepted in Templates, where `doctitle' may be omitted.
@item
Avoid long stretches of input code. Nobody is going to read
them in print. Create small examples. However, this does not mean
-it has be minimal.
+it has to be minimal.
@item
Specify durations for at least the first note of every bar.
@@ -679,7 +679,7 @@ command ;)
@unnumberedsubsubsec Cross references
Enter the exact @code{@@node} name of the target reference between
-the brackets (address@hidden@address@hidden@@address@hidden address@hidden).
Do not
+the brackets (address@hidden@address@hidden@@address@hidden address@hidden).
Do not
split a cross-reference across two lines -- this causes the
cross-reference to be rendered incorrectly in html documents.
diff --git a/Documentation/contributor/introduction.itexi
b/Documentation/contributor/introduction.itexi
index b0948ba..08da4a0 100644
--- a/Documentation/contributor/introduction.itexi
+++ b/Documentation/contributor/introduction.itexi
@@ -233,14 +233,14 @@ solved/explained with 2 or 3 sentences from a mentor.
If you have been working on a task much longer than was originally
estimated, stop and ask your mentor. There may have been a
miscommunication, or there may be some time-saving tips that could
-vastly simply your task.
+vastly simplify your task.
@item
Send patches to your mentor for initial comments.
@item
Inform your mentor if you're going to be away for a month, or if
-you leave entirely. Contributing to lilypond isn't for everybody;
+you leave entirely. Contributing to LilyPond isn't for everybody;
just let your mentor know so that we can reassign that work to
somebody else.
@@ -289,7 +289,7 @@ for docs and translations; code patches should almost
always go to
@item
Keep track of patches from your contributor. Either upload them
to Rietveld yourself, or help+encourage them to upload the patches
-themselves. When a patch is on Rietveld, it's your responbility
+themselves. When a patch is on Rietveld, it's your responsibility
to get comments for it, and to add a link to the patch to the
google tracker. (tag it @qq{patch-new}, or @qq{patch-review} if
you feel very confident in it)
@@ -316,5 +316,3 @@ working on a patch, what step(s) are you working on?
@end enumerate
-
-
diff --git a/Documentation/contributor/quick-start.itexi
b/Documentation/contributor/quick-start.itexi
index 6d6dec3..acc8440 100644
--- a/Documentation/contributor/quick-start.itexi
+++ b/Documentation/contributor/quick-start.itexi
@@ -35,7 +35,7 @@ software. We recommend using VirtualBox as it is available
for all
major operating systems and is very easy to install & configure.
The LilyDev disk image can also be written to a USB device or @q{burnt}
-to a DVD -- it is approximately 900 GB in size -- and installed just
+to a DVD -- it is approximately 900 MB in size -- and installed just
like any standard GNU/Linux distribution.
The current image is based on a 32bit version of Debian 8 (@q{Jessie})
@@ -56,8 +56,7 @@ patch or compiled software before. More experienced
developers (who
prefer to use their own development environment) may still find it
instructive to skim over the following information.}
-If you are not familiar with GNU/Linux, it may be beneficial to read a
-a few @qq{introduction to Linux} type web pages.
+If you are not familiar with GNU/Linux, it may be beneficial to read a few
@qq{introduction to Linux} type web pages.
@menu
* Installing LilyDev in VirtualBox::
@@ -76,15 +75,15 @@ you can skip this section and go straight to
@ref{lily-git}.}
@enumerate
@item
-Download Virtualbox from here:
+Download VirtualBox from here:
@example
@uref{http://www.virtualbox.org/wiki/Downloads}
@end example
@warning{In virtualization terminology, the operating system where
-Virtualbox is installed is known as the @strong{host}. LilyDev
-will be installed @q{inside} Virtualbox as a @strong{guest}.}
+VirtualBox is installed is known as the @strong{host}. LilyDev
+will be installed @q{inside} VirtualBox as a @strong{guest}.}
@item
Start the VirtualBox software and click @q{New} to create a new
@@ -113,7 +112,7 @@ and its location accordingly.
@item
Verify the summary details and click @q{Create}, when you are satisfied.
-Your new guest will be displayed in the Virtualbox window.
+Your new guest will be displayed in the VirtualBox window.
@warning{The image contains a @q{686-pae} kernel, so you must enable
@code{PAE} within the virtual machine's settings -- click on
@@ -261,7 +260,7 @@ the software directly. See @ref{Manually installing
lily-git.tcl}.
@item
Finally, lily-git is always part of the LilyPond source code and is
-located in @file{$LILYPOND_GIT/scripts/auxillar/lily-git.tcl}.
+located in @file{$LILYPOND_GIT/scripts/auxiliar/lily-git.tcl}.
@end itemize
@@ -313,7 +312,7 @@ directory to view and edit the source files.
@end enumerate
@noindent
-If this is the first time you have compiled LilyPond then please go
+If this is the first time you compile LilyPond then please go
to @ref{Compiling with LilyDev} before reading on.
@@ -432,7 +431,7 @@ current state of the remote repository (at
@code{git.sv.gnu.org}).
@section Compiling with LilyDev
LilyDev is our @q{remix} of Debian which contains all the
-necessary dependencies to do lilypond development; for more
+necessary dependencies to do LilyPond development; for more
information, see @ref{LilyDev}.
@subsubheading Preparing the build
@@ -452,7 +451,7 @@ cd build/
@subsubheading Building @code{lilypond}
-Compiling lilypond will likely take between 5 and 60 minutes,
+Compiling LilyPond will likely take between 5 and 60 minutes,
depending on your computer's speed and available RAM. We
recommend that you minimize the terminal window while it is
building; this can have a non-negligible effect on compilation
@@ -491,7 +490,7 @@ firefox $LILYPOND_GIT/build/out-www/offline-root/index.html
@subsubheading Installing
-Don't. There is no reason to install lilypond within LilyDev.
+Don't. There is no reason to install LilyPond within LilyDev.
All development work can (and should) stay within the
@file{$LILYPOND_GIT} directory, and any personal composition
or typesetting work should be done with an official GUB release.
@@ -532,6 +531,3 @@ LilyDev.
@item @ref{Working with source code}
@item @ref{Compiling}
@end itemize
-
-
-
diff --git a/Documentation/contributor/source-code.itexi
b/Documentation/contributor/source-code.itexi
index 250ad99..976cb28 100644
--- a/Documentation/contributor/source-code.itexi
+++ b/Documentation/contributor/source-code.itexi
@@ -24,7 +24,7 @@ particularly if they are working on major new features.
@node Manually installing lily-git.tcl
@section Manually installing lily-git.tcl
-We have created an easy-to-use GUI to simplify git for new
+We have created an easy-to-use GUI to simplify Git for new
contributors. If you are comfortable with the command-line, then
skip ahead to @ref{Starting with Git}.
@@ -155,7 +155,7 @@ Once Git is installed, get a copy of the source code:
git clone git://git.sv.gnu.org/lilypond.git ~/lilypond-git
@end example
-The above command will put the it in @file{~/lilypond-git}, where
+The above command will put the source code in @file{~/lilypond-git}, where
@code{~} represents your home directory.
@subsubheading Technical details
@@ -263,8 +263,8 @@ in this manual.
@node Git for the impatient
@subsection Git for the impatient
address@hidden intent of this subsection is to get you working on lilypond as
-soon as possible. If you want to learn about git, go read
address@hidden intent of this subsection is to get you working on LilyPond as
+soon as possible. If you want to learn about Git, go read
@ref{Other Git documentation}.
@*
Also, these instructions are designed to eliminate the most common
@@ -290,7 +290,7 @@ about using branches.
Start by updating the repository, then making a new branch. Call
the branch anything you want as long as the name starts with
@code{dev/}. Branch names that don't begin with @code{dev/} are
-reserved for special things in lilypond.
+reserved for special things in LilyPond.
@example
git checkout master
@@ -327,11 +327,11 @@ git checkout dev/cg
@end example
Branches that begin with @code{origin/} are part of the remote repository,
-rather than your local repository, so when you check them out you get a
+rather than your local repository, so when you check them out you get a
temporary local branch. You should never make changes directly on a
branch beginning with @code{origin/}. You get changes into the remote
repository by making them in local branches, and then pushing them to
address@hidden/staging} as described below.
address@hidden/staging} as described below.
@subsubheading Make your changes
@@ -400,14 +400,14 @@ git rebase master
Due to the speed of lilypond development, sometimes
@code{master} has changed so much that your branch can no
-longer be applied to it. In that happens, you will have a merge
+longer be applied to it. If that happens, you will have a merge
conflict. Stop for a moment to either cry or have a stiff drink,
then proceed to @ref{Merge conflicts}.
@subsubheading Upload your branch
-Finally, you're finished your changes. Time to upload for review.
+Finally, you've finished your changes. Time to upload for review.
Make sure that you're on your branch, then upload:
@example
@@ -450,7 +450,7 @@ your work, don't despair. You can get it back by using
@code{git reflog}.
The use of @code{git reflog} is not covered here.}
@warning{If any of the commits on your branch represent partial work that will
-not pass @var{make && make doc}, you @strong{must} squash these
+not pass @var{make && make doc}, you @strong{must} squash these
commits into a working commit. Otherwise, your push will break staging
and will not be able to be merged to master. In general, you will
be safer to have one commit per push.}
@@ -464,7 +464,7 @@ prepare your upload:
@example
git fetch
git rebase origin/staging dev/cg~0
-gitk HEAD
+gitk HEAD
@end example
@warning{Do not skip the @command{gitk} step; a quick 5-second
@@ -516,10 +516,10 @@ not present in @code{origin/master}.
@subsubheading Delete your branch (UNSAFE)
@c don't give explicit commands here -- this is too dangerous to copy and paste
-Sometimes everything goes wrong. If you want to remove a branch even though
+Sometimes everything goes wrong. If you want to remove a branch even though
it will cause your work to be lost (that is, if the contents of @code{dev/cg}
are @strong{not} present in master), follow the instructions in @qq{Delete
-your branch (safe)}, but replace the @code{-d} on the final line with
+your branch (safe)}, but replace the @code{-d} on the final line with
a @code{-D}.
@@ -719,10 +719,6 @@ only be used as a last resort.
@node Downloading individual branches
@unnumberedsubsubsec Downloading individual branches
-
address@hidden, should be deleted!}
-
-
Once you have initialized an empty Git repository on your system
(see @ref{Initializing a repository}), you can download a remote
branch into it. Make sure you know which branch you want to start
@@ -1355,10 +1351,6 @@ Account Settings must have the @q{Access for less secure
apps} set to
Move into the top source directory and then configure @command{git
cl} with the following commands:
address@hidden
-Move into the top source directory and then configure @command{git
-cl} with the following commands:
-
@example
cd $LILYPOND_GIT
git cl config
@@ -2560,4 +2552,3 @@ Github help: @uref{http://help.github.com/}
(very highly recommended by Graham)
@end itemize
-
diff --git a/Documentation/included/compile.itexi
b/Documentation/included/compile.itexi
index 7253087..c6943bf 100644
--- a/Documentation/included/compile.itexi
+++ b/Documentation/included/compile.itexi
@@ -160,7 +160,7 @@ check and a full make doc. - James
@unnumberedsubsubsec Fedora
The following instructions were tested on @q{Fedora 22} and include all
-the software to both compile LilyPond and build the documenation.
+the software to both compile LilyPond and build the documentation.
@itemize
@@ -213,7 +213,7 @@ it is recommended that you also need to install @code{git}.
sudo dnf install git
@end example
-Also see @ruser{Starting with Git}.
+Also see @rcontrib{Starting with Git}.
@item
To use the @code{lily-git.tcl} GUI;
@@ -222,7 +222,7 @@ To use the @code{lily-git.tcl} GUI;
sudo dnf install tk
@end example
-See @ruser{lily-git}.
+See @rcontrib{lily-git}.
@end itemize
@@ -233,7 +233,7 @@ See @ruser{lily-git}.
The following instructions were tested on @q{Linux Mint 17.1} and
@q{LMDE - Betsy} and include all the software to both compile LilyPond
-and build the documenation.
+and build the documentation.
@itemize
@@ -283,7 +283,7 @@ it is recommended that you also need to install @code{git}.
sudo apt-get install git
@end example
-Also see @ruser{Starting with Git}.
+Also see @rcontrib{Starting with Git}.
@item
To use the @code{lily-git.tcl} GUI;
@@ -292,7 +292,7 @@ To use the @code{lily-git.tcl} GUI;
sudo apt-get install tk
@end example
-Also see @ruser{lily-git}.
+Also see @rcontrib{lily-git}.
@end itemize
@@ -301,7 +301,7 @@ Also see @ruser{lily-git}.
@unnumberedsubsubsec OpenSUSE
The following instructions were tested on @q{OpenSUSE 13.2} and include
-all the software to both compile LilyPond and build the documenation.
+all the software to both compile LilyPond and build the documentation.
@itemize
@@ -337,7 +337,7 @@ it is recommended that you also need to install @code{git}.
sudo apt-get install git
@end example
-Also see @ruser{Starting with Git}.
+Also see @rcontrib{Starting with Git}.
@item
To use the @code{lily-git.tcl} GUI;
@@ -346,7 +346,7 @@ To use the @code{lily-git.tcl} GUI;
sudo zypper install tk
@end example
-Also see @ruser{lily-git}.
+Also see @rcontrib{lily-git}.
@end itemize
@@ -357,7 +357,7 @@ Also see @ruser{lily-git}.
The following commands were tested on Ubuntu versions @code{14.04 LTS},
@code{14.10} and @code{15.04} and include all the software to both
-compile LilyPond and build the documenation.
+compile LilyPond and build the documentation.
@itemize
@@ -373,7 +373,7 @@ sudo apt-get build-dep lilypond
Download and install additional @q{build} tools required for compiling;
@example
-sudo apt-get install autoconf fonts-texgyre texlive-land-cyrillic
+sudo apt-get install autoconf fonts-texgyre texlive-lang-cyrillic
@end example
@item
@@ -385,7 +385,7 @@ it is recommended that you also need to install @code{git}.
sudo apt-get install git
@end example
-Also see @ruser{Starting with Git}.
+Also see @rcontrib{Starting with Git}.
@item
To use the @code{lily-git.tcl} GUI;
@@ -394,7 +394,7 @@ To use the @code{lily-git.tcl} GUI;
sudo apt-get install tk
@end example
-Also see @ruser{lily-git}.
+Also see @rcontrib{lily-git}.
@end itemize
@@ -873,7 +873,7 @@ make conf=prof install
@node Useful make variables
@subsection Useful @command{make} variables
-If a less verbose build output if desired, the variable
+If a less verbose build output is desired, the variable
@code{QUIET_BUILD} may be set to @code{1} on @command{make}
command line, or in @file{local.make} at top of the build tree.
@@ -1347,7 +1347,7 @@ CONFIG_SHELL=/bin/bash bash -c ./configure
@unnumberedsubsec FreeBSD
-To use system fonts, dejaview must be installed. With the default
+To use system fonts, dejavu must be installed. With the default
port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
diff --git a/Documentation/included/helpus.itexi
b/Documentation/included/helpus.itexi
index 96f697b..67230ac 100644
--- a/Documentation/included/helpus.itexi
+++ b/Documentation/included/helpus.itexi
@@ -10,7 +10,7 @@ you get involved! Your contribution will help a large group
of users
make beautifully typeset music.
Even working on small tasks can have a big impact: taking care of
-them allows experienced developers work on advanced tasks, instead
+them allows experienced developers to work on advanced tasks, instead
of spending time on those simple tasks.
For a multi-faceted project like LilyPond, sometimes it's tough to know
@@ -128,4 +128,3 @@ with larger tasks in the future.
@end macro
@end ignore
-
--
2.6.2
HTH
Patrick
- Fixed some typos and broken links in CG,
pls <=