Skip to content

Commit

Permalink
Avoid colloquial contractions like it'll, must've, might've, should've
Browse files Browse the repository at this point in the history
  • Loading branch information
bagder committed Dec 17, 2016
1 parent 3f5be48 commit 4d3e8c6
Show file tree
Hide file tree
Showing 45 changed files with 127 additions and 123 deletions.
2 changes: 1 addition & 1 deletion GUIDELINES.md
Expand Up @@ -24,7 +24,7 @@ Let's try to use the correct UTF-8 characters!

## Avoid the short forms of dir and repo

They're rather called "directory" and "respository"
They are rather called "directory" and "respository"

## Internet with a capital I

Expand Down
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -8,13 +8,13 @@ why all those millions of existing users use it.

This book is meant to be interesting and useful to both casual readers and the
somewhat more experienced developers, and offers something for you all to pick
and choose from. Don't read it from front to back. Read the chapters you're
and choose from. Don't read it from front to back. Read the chapters you are
curious about and go back and forth as you see fit.

I hope to run this book project as I do all other projects I work on: in the
open, completely free to download and read, free for anyone to comment on,
available for everyone to contribute to and help out with. Send your bug
reports, pull requests or critiques to me and I'll improve this book
reports, pull requests or critiques to me and I will improve this book
accordingly.

This book will never be finished. I intend to keep working on it and while I
Expand Down Expand Up @@ -48,7 +48,7 @@ site](https://daniel.haxx.se/).
## Help!

If you find mistakes, omissions, errors or blatant lies in this document,
please send me a refreshed version of the affected paragraph and I'll make
please send me a refreshed version of the affected paragraph and I will make
amended versions. I will give proper credits to everyone who helps out! I hope
to make this document better over time.

Expand Down
6 changes: 3 additions & 3 deletions building-tls.md
Expand Up @@ -24,9 +24,9 @@ machine.

## configure

Below, you'll learn how to tell configure to use the different libraries. Note
that for all libraries except OpenSSL and its siblings, you must *disable* the
check for OpenSSL by using `--without-ssl`.
Below, you will learn how to tell configure to use the different
libraries. Note that for all libraries except OpenSSL and its siblings, you
must *disable* the check for OpenSSL by using `--without-ssl`.

### OpenSSL, BoringSSL, libressl

Expand Down
15 changes: 8 additions & 7 deletions callback-read.md
Expand Up @@ -9,9 +9,9 @@ The `read_callback` function must match this prototype:
size_t read_callback(char *buffer, size_t size, size_t nitems, void *stream);

This callback function gets called by libcurl when it wants to send data to
the server. This is a transfer that you've set up to upload data or otherwise
send it off to the server. This callback will be called over and over until
all data has been delivered or the transfer failed.
the server. This is a transfer that you have set up to upload data or
otherwise send it off to the server. This callback will be called over and
over until all data has been delivered or the transfer failed.

The **stream** pointer points to the private data set with `CURLOPT_READDATA`:

Expand All @@ -22,8 +22,9 @@ If this callback isn't set, libcurl instead uses 'fread' by default.
The data area pointed at by the pointer **buffer** should be filled up with at
most **size** multiplied with **nitems** number of bytes by your function. The
callback should then return the number of bytes that it stored in that memory
area, or 0 if we've reached the end of the data. The callback can also return
a few "magic" return codes to cause libcurl to return failure immediately or
to pause the particular transfer. See the [CURLOPT_READFUNCTION man
page](https://curl.haxx.se/libcurl/c/CURLOPT_READFUNCTION.html) for details.
area, or 0 if we have reached the end of the data. The callback can also
return a few "magic" return codes to cause libcurl to return failure
immediately or to pause the particular transfer. See the [CURLOPT_READFUNCTION
man page](https://curl.haxx.se/libcurl/c/CURLOPT_READFUNCTION.html) for
details.

2 changes: 1 addition & 1 deletion cmdline-configfile.md
Expand Up @@ -51,7 +51,7 @@ The argument to an option can be specified without double quotes and then curl
will treat the next space or newline as the end of the argument. So if you
want to provide an argument with embedded spaces you must use double quotes.

The user agent string example we've used above has no white spaces and
The user agent string example we have used above has no white spaces and
therefore it can also be provided without the quotes like:

user-agent = Everything-is-an-agent
Expand Down
10 changes: 5 additions & 5 deletions cmdline-globbing.md
Expand Up @@ -66,16 +66,16 @@ both the web server and the mail server:

### Output variables for globbing

In all the globbing examples previously in this chapter we've selected to use
the `-O / --remote-name` option, which makes curl save the target file using
the file name part of the used URL.
In all the globbing examples previously in this chapter we have selected to
use the `-O / --remote-name` option, which makes curl save the target file
using the file name part of the used URL.

Sometimes that is not enough. You're downloading multiple files and maybe you
Sometimes that is not enough. You are downloading multiple files and maybe you
want to save them in a different subdirectory or create the saved file names
differently. curl, of course, has a solution for these situations as well:
output file name variables.

Each "glob" used in a URL gets a separate variable. They're referenced as
Each "glob" used in a URL gets a separate variable. They are referenced as
'#[num]' - that means the single letter '#' followed by the glob number which
starts with 1 for the first glob and ends with the last glob.

Expand Down
6 changes: 3 additions & 3 deletions cmdline-listopts.md
Expand Up @@ -5,10 +5,10 @@ keep increasing over time. Chances are the number of options will reach 250
within a few years.

In order to find out which options you need to perform as certain action, you
can, of course, list all options, scan through the list and pick the one you're
looking for. `curl --help` or simply `curl -h` will get you a list of all
can, of course, list all options, scan through the list and pick the one you
are looking for. `curl --help` or simply `curl -h` will get you a list of all
existing options with a brief explanation. If you don't really know what
you're looking for, you probably won't be entirely satisfied.
you are looking for, you probably won't be entirely satisfied.

Then you can instead opt to use `curl --manual` which will output the
entire man page for curl plus an appended tutorial for the most common use
Expand Down
2 changes: 1 addition & 1 deletion cmdline-passwords.md
Expand Up @@ -15,7 +15,7 @@ wants to request a page requiring HTTP authentication and her password is

### Command line leakage

Several potentially bad things are going on here. First, we're entering a
Several potentially bad things are going on here. First, we are entering a
password on the command line and the command line might be readable for other
users on the same system (assuming you have a multi-user system). curl
will help minimize that risk by trying to blank out passwords from process
Expand Down
6 changes: 3 additions & 3 deletions cmdline-versions.md
Expand Up @@ -4,9 +4,9 @@
already then worked on the specified URL and none, one or more command-line
options given to it.

Since then we've added more options. We add options as we go along and almost
every new release of curl has one or a few new options that allow users to
modify certain aspects of its operation.
Since then we have added more options. We add options as we go along and
almost every new release of curl has one or a few new options that allow users
to modify certain aspects of its operation.

With the curl project's rather speedy release chain with a new release
shipping every eight weeks, it is almost inevitable that you are at least not
Expand Down
2 changes: 1 addition & 1 deletion cmdline.md
Expand Up @@ -17,7 +17,7 @@ provided by the curl project, lots of people install it using a package tool
for their operating system and yet another portion of users download binary
install packages from sources they trust.

No matter how you do it, make sure you're getting your version from a trusted
No matter how you do it, make sure you are getting your version from a trusted
source and that you verify digital signatures or the authenticity of the
packages in other ways.

Expand Down
10 changes: 5 additions & 5 deletions curl-bugs.md
Expand Up @@ -63,11 +63,11 @@ test cases, runs the test and verifies that the outcome is the correct one
and that no other problem happened, like a memory leak or something fishy in
the protocol layer.

The test suite is meant to be possible to run after you've built curl yourself
and there are a fair number of volunteers who also help out by running the
test suite automatically a few times per day to make sure the latest commits
get a run. This way, we hopefully discover the worst flaws pretty soon after
they were introduced.
The test suite is meant to be possible to run after you have built curl
yourself and there are a fair number of volunteers who also help out by
running the test suite automatically a few times per day to make sure the
latest commits get a run. This way, we hopefully discover the worst flaws
pretty soon after they were introduced.

We don't test everything and even when we try to test things there will always
be subtle details that get through and that we, sometimes years after the
Expand Down
4 changes: 2 additions & 2 deletions curl-comm.md
Expand Up @@ -7,7 +7,7 @@ all communication public and we use open communication channels. Most
discussions are held on mailing lists, we use bug trackers where all issues
are discussed and handled with full insight for everyone who cares to look.

It is important to realize that we're all jointly taking care of the project,
It is important to realize that we are all jointly taking care of the project,
we fix problems and we add features. Sometimes a regular contributor grows
bored and fades away, sometimes a new eager contributor steps out from the
shadows and starts helping out more. To keep this ship going forward as well
Expand All @@ -21,7 +21,7 @@ communication—no fancy web forums or similar. Using a mailing list is
therefore becoming an art that isn't practised everywhere and may be a bit
strange and unusual to you. But fear not. It is just about sending emails to
an address that then sends that e-mail out to all the subscribers. Our mailing
lists have at most a few thousand subscribers. If you're mailing for the first
lists have at most a few thousand subscribers. If you are mailing for the first
time, it might be good to read a few old mails first to get to learn the
culture and what's considered good practice.

Expand Down
2 changes: 1 addition & 1 deletion curl-does.md
Expand Up @@ -19,7 +19,7 @@ about HTML or anything else of the content that is popular to transfer over
HTTP, but it knows all about how to transfer such data over HTTP.

Both products are frequently used not only to drive thousands or millions of
scripts and applications for an Internet connected world, but they're also
scripts and applications for an Internet connected world, but they are also
widely used for server testing, protocol fiddling and trying out new things.

The library is used in every imaginable sort of embedded device where Internet
Expand Down
6 changes: 3 additions & 3 deletions curl-etiquette.md
Expand Up @@ -34,7 +34,7 @@ When replying to a message from the list, make sure that you do "group reply"
or "reply to all", and not just reply to the author of the single mail you
reply to.

We're actively discouraging replying back to the single person by setting the
We are actively discouraging replying back to the single person by setting the
Reply-To: field in outgoing mails back to the mailing list address, making it
harder for people to mail the author only by mistake.

Expand Down Expand Up @@ -69,8 +69,8 @@ for your comments. When you want to add a comment you do so, inline, right
after the quotes that relate to your comment. Then you continue downwards
again.

When most of the quotes have been removed and you've added your own words,
you're done!
When most of the quotes have been removed and you have added your own words,
you are done!

#### HTML is not for mails

Expand Down
5 changes: 3 additions & 2 deletions curl-future.md
Expand Up @@ -5,7 +5,7 @@
There's no slowdown in sight in curl's future, bugs reported, development
pace or how Internet protocols are being developed or updated.

We're looking forward to support for more protocols, support for more features
We are looking forward to support for more protocols, support for more features
within the already supported protocols, and more and better APIs for libcurl to
allow users to do transfers even better and faster.

Expand All @@ -16,7 +16,8 @@ yes, a list of known problems we would like to get fixed.

There's a [ROADMAP](https://curl.haxx.se/dev/roadmap.html) document that
describe some plans for the short-term that some of the active developers
thought they'd work on next. No promises or guarantees are implied, of course.
thought they wouldd work on next. No promises or guarantees are implied, of
course.

We are highly dependent on developers to join in and work on what they want to
get done, be it bug fixes or new features.
5 changes: 3 additions & 2 deletions curl-maillists.md
Expand Up @@ -15,8 +15,9 @@ See https://cool.haxx.se/mailman/listinfo/curl-users
### curl-library

The main development list, and also for users of libcurl. We discuss how to
use libcurl in applications as well as development of libcurl itself. You'll
find lots of questions on libcurl behavior, debugging and documentation issues.
use libcurl in applications as well as development of libcurl itself. You will
find lots of questions on libcurl behavior, debugging and documentation
issues.

See https://cool.haxx.se/mailman/listinfo/curl-library

Expand Down
2 changes: 1 addition & 1 deletion curl-name.md
Expand Up @@ -27,7 +27,7 @@ programming language. That curl still [exists](http://www.curl.com).

Several libcurl bindings for various programming languages use the term "curl"
or "CURL" in part or completely to describe their bindings, so sometimes
you'll find users talking about curl but targeting neither the command-line tool
you will find users talking about curl but targeting neither the command-line tool
nor the library that is made by this project.

### As a verb
Expand Down
2 changes: 1 addition & 1 deletion curl.md
Expand Up @@ -2,7 +2,7 @@

![curl logo](curl-logo.jpg)

A funny detail about Open Source projects is that they're called "projects",
A funny detail about Open Source projects is that they are called "projects",
as if they were somehow limited in time or ever can get done. The cURL
"project" is a number of loosely-coupled individual volunteers working on
writing software together with a common mission: to do reliable data transfers
Expand Down
2 changes: 1 addition & 1 deletion ftp-twoconnections.md
Expand Up @@ -36,7 +36,7 @@ the second connection that then curl connects to. Outgoing connections to a
new port are generally easier and less restricted for end users and clients,
but it then requires that the network in the server's end allows it.

Passive connections are enabled by default, but if you've switched on active
Passive connections are enabled by default, but if you have switched on active
before, you can switch back to passive with `--ftp-pasv`.

You can also explicitly ask curl not to use EPSV (which is a slightly newer
Expand Down
4 changes: 2 additions & 2 deletions http-basics.md
@@ -1,7 +1,7 @@
### HTTP protocol basics

(This assumes you've read the [Network and protocols](protocols.md) section or
are otherwise already familiar with protocols.)
(This assumes you have read the [Network and protocols](protocols.md) section
or are otherwise already familiar with protocols.)

HTTP is a protocol that is easy to learn the basics of. A client connects to a
server—and it is always the client that takes the initiative—sends a
Expand Down
2 changes: 1 addition & 1 deletion http-cookies.md
Expand Up @@ -85,7 +85,7 @@ it will not flush session cookies unless you tell it to.
### New cookie session

Instead of telling curl when a session ends, in order to flush session cookies
and with this basically signal to the server that we're starting a new
and with this basically signal to the server that we are starting a new
session, curl features an option that lets the user tell when a new session
begins.

Expand Down
4 changes: 2 additions & 2 deletions http-post.md
Expand Up @@ -91,7 +91,7 @@ As an example, you could POST a name to have it encoded by curl:

A little convenience feature that could be suitable to mention in this context
(even though it isn't for POSTing), is the `-G` or `--get` option, which takes
all data you've specified with the different `-d` variants and appends that
all data you have specified with the different `-d` variants and appends that
data on the right end of the URL separated with a '?' and then makes curl send
a GET instead.

Expand Down Expand Up @@ -176,7 +176,7 @@ own server or a test server that just outputs exactly what it gets. Completing
that form submission will then show you exactly how a browser sends it.

A third option is, of course, to use a network capture tool such as Wireshark to
check exactly what is sent over the wire. If you're working with HTTPS, you
check exactly what is sent over the wire. If you are working with HTTPS, you
can't see form submissions in clear text on the wire but instead you need to
make sure you can have wireshark extract your TLS private key from your
browser. See the Wireshark documentation for details on doing that.
Expand Down
2 changes: 1 addition & 1 deletion http-postvspost.md
Expand Up @@ -14,7 +14,7 @@ data correctly. A client cannot just pick a format of its own choice.

## HTML web forms

When we're talking browsers and HTML, the standard way is to offer a form to
When we are talking browsers and HTML, the standard way is to offer a form to
the user that sends off data when the form has been filled in. The `<form>`
tag is what makes one of those appear on the web page. The tag instructs the
browser how to format its POST. If the form tag includes
Expand Down
2 changes: 1 addition & 1 deletion http-put.md
@@ -1,6 +1,6 @@
## PUT

The difference between a PUT and a POST is subtle. They're virtually identical
The difference between a PUT and a POST is subtle. They are virtually identical
over the wire except for the different method strings. Where POST is meant to
pass on data to a remote resource, PUT is supposed to be the new version of
that resource.
Expand Down
2 changes: 1 addition & 1 deletion http-redirects.md
Expand Up @@ -108,7 +108,7 @@ different host curl limits what it sends away to other hosts than the original
within the same "transfer".

So if you want the credentials to also get sent to the following host names
even though they're not the same as the original—presumably because you
even though they are not the same as the original—presumably because you
trust them and know that there's no harm in doing that—you can tell curl that
it is fine to do so by using the `--location-trusted` option.

Expand Down
2 changes: 1 addition & 1 deletion http.md
Expand Up @@ -5,7 +5,7 @@ important and most frequently used protocol that curl supports. This chapter
will explain how to do effective HTTP transfers and general fiddling with
curl.

This will mostly work the same way for HTTPS, as they're really the same thing
This will mostly work the same way for HTTPS, as they are really the same thing
under the hood, as HTTPS is HTTP with an extra security TLS layer. See also
the specific [HTTPS](#https) section below.

Expand Down
12 changes: 6 additions & 6 deletions libcurl-cleanup.md
@@ -1,14 +1,14 @@
## Cleanup

In previous sections we've discussed how to setup handles and how to drive the
transfers. All transfers will, of course, end up at some point, either successfully
or with a failure.
In previous sections we have discussed how to setup handles and how to drive
the transfers. All transfers will, of course, end up at some point, either
successfully or with a failure.

### Multi API

When you've finished a single transfer with the multi API, you use
`curl_multi_info_read()` to identify exactly which easy handle was
completed and you remove that easy handle from the multi handle with
When you have finished a single transfer with the multi API, you use
`curl_multi_info_read()` to identify exactly which easy handle was completed
and you remove that easy handle from the multi handle with
`curl_multi_remove_handle()`.

If you remove the last easy handle from the multi handle so there are no more
Expand Down
4 changes: 2 additions & 2 deletions libcurl-connectionreuse.md
Expand Up @@ -8,13 +8,13 @@ creating a new one offers significant benefits in speed and required resources.

### Easy API pool

When you're using the easy API, or, more specifically, curl_easy_perform(),
When you are using the easy API, or, more specifically, curl_easy_perform(),
libcurl will keep the pool associated with the specific easy handle. Then
reusing the same easy handle will ensure it can reuse its connection.

### Multi API pool

When you're using the multi API, the connection pool is instead kept
When you are using the multi API, the connection pool is instead kept
associated with the multi handle. This allows you to cleanup and re-create
easy handles freely without risking losing the connection pool, and it allows
the connection used by one easy handle to get reused by a separate one in a
Expand Down

0 comments on commit 4d3e8c6

Please sign in to comment.