Skip to content

Commit b0e5bac

Browse files
committed
Remove trailing whitespace
Trailing whitespace is generally considered harmful and untidy in both code and text-based documentation. Remove the instances of it in our codebase.
1 parent b8f9b11 commit b0e5bac

13 files changed

+92
-92
lines changed

docker/README.md

+57-57
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,43 @@
44
1. Run the dockers
55

66
./docker/run_dockers.bsh
7-
7+
88
2. **Enjoy** all your new package files in
99

1010
./repos/
11-
11+
1212
### Slightly longer version ###
1313

1414
1. Generate GPG keys for everything (See GPG Signing)
1515
2. `export REPO_HOSTNAME=repo.something.com`
1616
4. Generate git-lfs/repo packages and sign all packages
1717

1818
./docker/run_dockers.bsh
19-
19+
2020
5. Host the `/repo` on the `REPO_HOSTNAME` server
2121
6. Test the repos and git-lfs in a client environment
2222

2323
./docker/test_dockers.bsh
2424

2525
## Using the Dockers ##
2626

27-
All docker commands need to either be run as root **or** as a user with docker
28-
permissions. Adding your user name to the docker group (or setting up boot2docker
27+
All docker commands need to either be run as root **or** as a user with docker
28+
permissions. Adding your user name to the docker group (or setting up boot2docker
2929
environment) is probably the easiest.
3030

31-
For Mac and Windows users, the git-lfs repo needs to be in your Users directory
31+
For Mac and Windows users, the git-lfs repo needs to be in your Users directory
3232
or else boot2docker magic won't work. Alternatively, you could add addition
33-
mount points like
33+
mount points like
3434
[this](http://stackoverflow.com/questions/26639968/boot2docker-startup-script-to-mount-local-shared-folder-with-host)
3535

3636
### Running Dockers ###
3737

3838
In order to run the dockers, the docker has to be run with a
39-
lot of arguments to get the mount points right, etc... A convenient script is
39+
lot of arguments to get the mount points right, etc... A convenient script is
4040
supplied to make this all easy. Simply run
4141

4242
./docker/run_docker.bsh
43-
43+
4444
All the images are pulled automatically, and then run.
4545

4646
To only run certain docker images, supply them as arguments, e.g.
@@ -54,12 +54,12 @@ And only those images will be run.
5454
### Development in Dockers ###
5555

5656
Sometimes you don't want to just build git-lfs and destroy the container, you
57-
want to get in there, run a lot of command, debug, develop, etc... To do this,
57+
want to get in there, run a lot of command, debug, develop, etc... To do this,
5858
the best command to run is bash, and then you have an interactive shell to use
5959

6060
./docker/run_docker.bsh {image name(s)} -- bash
6161

62-
After listing the image(s) you want to run, add a double dash (--) and then any
62+
After listing the image(s) you want to run, add a double dash (--) and then any
6363
command (and arguments) you want executed in the docker. Remember, the command
6464
you are executing has to be in the docker image.
6565

@@ -71,33 +71,33 @@ There are currently three type of docker images:
7171
git-lfs and save the package/repository in the `/repo` direrctory. This image
7272
also signs all rpms/debs if gpg signing is setup
7373
2. Environment building images: `{OS_NAME}_{OS_VERSION}_env` -
74-
These build or install the environment (dependencies) for building git-lfs. These
75-
are mostly important for CentOS because without these, many dependencies have
76-
to be built by a developer. These containers should create packages for these
74+
These build or install the environment (dependencies) for building git-lfs. These
75+
are mostly important for CentOS because without these, many dependencies have
76+
to be built by a developer. These containers should create packages for these
7777
dependencies and place them in `/repo`
7878
3. Testing images: `{OS_NAME}_{OS_VERSION}_test` - These images
7979
should install the repo and download the git-lfs packages and dependencies to test
8080
that everything is working, including the GPG signatures. Unlike the first two types,
81-
testing images are not guaranteed to work without GPG signatures. They should
81+
testing images are not guaranteed to work without GPG signatures. They should
8282
also run the test and integration scripts after installing git-lfs to verify
8383
everything is working in a **non-developer** setup. (With the exception that go
8484
is needed to build the tests...)
8585

8686
This default behavior for `./docker/run_dockers.bsh`
8787
is to run all of the _building images_. These
88-
containers will use the currently checked-out version of git-lfs and copy it
89-
into the docker, and run `git clean -xdf` to remove any non-tracked files,
90-
(but non-committed changes are kept). git-lfs is built, and a packages/repo is
88+
containers will use the currently checked-out version of git-lfs and copy it
89+
into the docker, and run `git clean -xdf` to remove any non-tracked files,
90+
(but non-committed changes are kept). git-lfs is built, and a packages/repo is
9191
created for each container.
9292

9393
These are all a developer would need to test the different OSes. And create the
94-
git-lfs rpm or deb packages in the `/repo` directory.
94+
git-lfs rpm or deb packages in the `/repo` directory.
9595

96-
In order to distribute git-lfs **and** build dependencies, the dependencies that
96+
In order to distribute git-lfs **and** build dependencies, the dependencies that
9797
that were built to create the docker images need to be saved too. Most of these
9898
are downloaded by yum/apt-get and do not need to be saved, but a few are not.
99-
In order to save the necessary dependencies, call `./docker/run_dockers.bsh` on
100-
`{OS_NAME}_{OS_VERSION}_env` and the rpms
99+
In order to save the necessary dependencies, call `./docker/run_dockers.bsh` on
100+
`{OS_NAME}_{OS_VERSION}_env` and the rpms
101101
will be extracted from the images and saved in the `./repo` directory.
102102
(This _can_ be done in one command)
103103

@@ -121,8 +121,8 @@ of the `run_docker.bsh` script.
121121
the lfs dockers. If set to 0, it will not check to see if a new pull is needed,
122122
and you will always run off of your currently cached images docker images.
123123

124-
`AUTO_REMOVE` - Default 1. Docker containers are automatically deleted on
125-
exit. If set to 0, the docker containers will not be automatically deleted upon
124+
`AUTO_REMOVE` - Default 1. Docker containers are automatically deleted on
125+
exit. If set to 0, the docker containers will not be automatically deleted upon
126126
exit. This can be useful for a post mortem analysis (using other docker commands
127127
not covered here). Just make sure you clean up the docker containers manually.
128128

@@ -146,8 +146,8 @@ The two major packages included are:
146146
`git-lfs-repo-release....*` - A package to install the repo.
147147

148148
When building, all **untracked** files are removed during RPM generation (except
149-
any stray directories containing a .git folder will not be cleared. This
150-
shouldn't be the case, unless you are temporarily storing another git repo in
149+
any stray directories containing a .git folder will not be cleared. This
150+
shouldn't be the case, unless you are temporarily storing another git repo in
151151
the git repo. This is a safety mechanism in git, so just keep in mind if you
152152
are producing packages.)
153153

@@ -157,9 +157,9 @@ The git-lfs-repo-release must contain the URL where the repo is to be hosted.
157157
The current default value is `git-lfs.github.com` but this can be overridden
158158
using the `REPO_HOSTNAME` env var, e.g.
159159

160-
export REPO_HOSTNAME=www.notgithub.uk.co
160+
export REPO_HOSTNAME=www.notgithub.uk.co
161161
./docker/run_dockers.bsh
162-
162+
163163
Now all the `git-lfs-repo-release....*` files will point to that URL instead
164164

165165
_Hint_: `REPO_HOSTNAME` can also be `www.notgithub.uk.co:2213/not_root_dir`
@@ -170,7 +170,7 @@ To test that all the OSes can download the packages, install, and run the tests
170170
again, run
171171

172172
./test_dockers.bsh
173-
173+
174174
(which is basically just `./docker/run_dockers.bsh ./docker/git-lfs-test_*`)
175175

176176
Remember to set `REPO_HOSTNAME` if you changed it for `./docker/build_docker.bsh`
@@ -189,10 +189,10 @@ or
189189

190190
## GPG signing ###
191191

192-
For private repo testing, GPG signing can be skipped. apt-get and yum can
192+
For private repo testing, GPG signing can be skipped. apt-get and yum can
193193
install .deb/.rpm directly without gpg keys and everything will work (with
194-
certain flags). This section is for distribution in a repo. Most if not all
195-
this functionality is automatically disabled when there is no signing key
194+
certain flags). This section is for distribution in a repo. Most if not all
195+
this functionality is automatically disabled when there is no signing key
196196
(`./docker/git-lfs_*.key`).
197197

198198
In order to sign packages, you need to generate and place GPG keys in the right
@@ -210,11 +210,11 @@ place. The general procedure for this is
210210
8. O for Okay
211211
9. Enter a secure password, make sure you will not forget it
212212
10. Generate Entropy!
213-
213+
214214
gpg --export-secret-key '<key ID>!' > filename.key
215-
215+
216216
e.g. `gpg --export-secret-key '547CF247!' > ./docker/git-lfs_centos_7.key`
217-
217+
218218
*NOTE*: the **!** is important in this command
219219

220220
Keep in mind, .key files must NEVER be accidentally committed to the repo.
@@ -229,37 +229,37 @@ that docker and save to the `/key` directory
229229
To prevent MANY passphrase entries at random times, a gpg-agent docker is used to
230230
cache your signing key. This is done automatically for you, whenever you call
231231
`./docker/run_dockers.bsh` on a building image (`git-lfs_*.dockerfile`). It can
232-
be manually preloaded by calling `./docker/gpg-agent_preload.bsh`. It will ask
232+
be manually preloaded by calling `./docker/gpg-agent_preload.bsh`. It will ask
233233
you for your passphrase, once for each unique key out of all the dockers. So if
234234
you use the same key for every docker, it will only prompt once. If you have 5
235235
different keys, you'll have prompts, with only the key ID to tell you which
236236
is which.
237237

238-
The gpg agent TTL is set to 1 year. If this is not acceptable for you, set the
238+
The gpg agent TTL is set to 1 year. If this is not acceptable for you, set the
239239
`GPG_MAX_CACHE` and `GPG_DEFAULT_CACHE` environment variables (in seconds) before
240240
starting the gpg-agent daemon.
241241

242-
`./docker/gpg-agent_start.bsh` starts the gpg-agent daemon. It is called
242+
`./docker/gpg-agent_start.bsh` starts the gpg-agent daemon. It is called
243243
automatically by `./docker/gpg-agent_preload.bsh`
244244

245-
`./docker/gpg-agent_stop.bsh` stops the gpg-agent daemon. It is called
245+
`./docker/gpg-agent_stop.bsh` stops the gpg-agent daemon. It is called
246246
automatically by `./docker/gpg-agent_preload.bsh`
247247

248-
`./docker/gpg-agent_preload.bsh` is called automatically by
249-
`./docker/run_dockers.bsh` when running any of the signing dockers.
248+
`./docker/gpg-agent_preload.bsh` is called automatically by
249+
`./docker/run_dockers.bsh` when running any of the signing dockers.
250250

251251
`./docker/gpg-agent_preload.bsh -r` - Stops and restarts the gpg agent daemon.
252252
This is useful for reloading keys when you update them in your host.
253253

254254
### GPG capabilities by Distro ###
255255

256-
Every distro has its own GPG signing capability. This is why every signing
256+
Every distro has its own GPG signing capability. This is why every signing
257257
docker (`git-lfs_*.dockerfile`) can have an associated key (`git-lfs_*.key`)
258258

259259
Debian **will** work with 4096 bit RSA signing subkeys like [1] suggests, but will
260260
also work with 4096 bit RSA signing keys.
261261

262-
CentOS will **not** work with subkeys[3]. CentOS 6 and 7 will work with 4096 bit
262+
CentOS will **not** work with subkeys[3]. CentOS 6 and 7 will work with 4096 bit
263263
RSA signing keys
264264

265265
You can make a 4096 RSA key for Debian and CentOS 6/7 (4 for step 1 above, and
@@ -275,11 +275,11 @@ You can make a 4096 RSA key for Debian and CentOS 6/7 (4 for step 1 above, and
275275

276276
## Adding additional OSes ##
277277

278-
To add another operating system, it needs to be added to the lfs_dockers
279-
repo and uploaded to docker hub. Then all that is left is to add it to the
278+
To add another operating system, it needs to be added to the lfs_dockers
279+
repo and uploaded to docker hub. Then all that is left is to add it to the
280280
IMAGES list in `run_dockers.bsh` and `test_dockers.bsh`
281281

282-
Follow the already existing pattern `{OS NAME}_{OS VERSION #}` where
282+
Follow the already existing pattern `{OS NAME}_{OS VERSION #}` where
283283
**{OS NAME}** and **{OS VERSION #}** should not contain underscores (\_).
284284

285285
## Docker Cheat sheet ##
@@ -289,23 +289,23 @@ Install https://docs.docker.com/installation/
289289
* list running dockers
290290

291291
docker ps
292-
292+
293293
* list stopped dockers too
294294

295295
docker ps -a
296-
296+
297297
* Remove all stopped dockers
298298

299299
docker rm $(docker ps --filter=status=exited -q)
300-
300+
301301
* List docker images
302302

303303
docker images
304304

305305
* Remove unused docker images
306306

307307
docker rmi $(docker images -a --filter=dangling=true -q)
308-
308+
309309
* Run another command (like bash) in a running docker
310310

311311
docker exec -i {docker name} {command}
@@ -329,19 +329,19 @@ ignoring many Ctrl+C's
329329
name/id and then used `docker stop` (signal 15) or `docker kill`
330330
(signal 9) to stop the docker. You can also use 'docker exec' to start another
331331
bash or kill command inside that container
332-
332+
333333
2. How do I re-enter a docker after it failed/succeeded?
334334

335335
Dockers are immediately deleted upon exit. The best way to work in a docker
336-
is to run bash (See Development in Dockers). This will let you to run the
336+
is to run bash (See Development in Dockers). This will let you to run the
337337
main build command and then continue.
338-
338+
339339
3. That answer's not good enough. How do I resume a docker?
340340

341-
Well, first you have to set the environment variable `AUTO_REMOVE=0`
342-
before running the image you want to resume. This will keep the docker
341+
Well, first you have to set the environment variable `AUTO_REMOVE=0`
342+
before running the image you want to resume. This will keep the docker
343343
around after stopping. (Be careful! They multiply like rabbits.) Then
344-
344+
345345
docker commit {container name/id} {new_name}
346-
346+
347347
Then you can `docker run` that new image.

docker/gpg-agent_start.bsh

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ CONTAINER_NAME=git-lfs-gpg
1313
if [ "$(docker inspect -f {{.State.Running}} ${CONTAINER_NAME})" != "true" ]; then
1414
OTHER_OPTIONS=("-e" "GPG_DEFAULT_CACHE=${GPG_DEFAULT_CACHE:-31536000}")
1515
OTHER_OPTIONS+=("-e" "GPG_MAX_CACHE=${GPG_MAX_CACHE:-31536000}")
16-
16+
1717
${SUDO} docker run -d -t "${OTHER_OPTIONS[@]}" --name ${CONTAINER_NAME} ${IMAGE_NAME}
1818
fi

docs/api/locking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ simplest use case: single branch locking. The API is designed to be extensible
2626
as we experiment with more advanced locking scenarios, as defined in the
2727
[original proposal](/docs/proposals/locking.md).
2828

29-
The [Batch API's `ref` property docs](./batch.md#ref-property) describe how the `ref` property can be used to support auth schemes that include the server ref. Locking API implementations should also only use it for authentication, until advanced locking scenarios have been developed.
29+
The [Batch API's `ref` property docs](./batch.md#ref-property) describe how the `ref` property can be used to support auth schemes that include the server ref. Locking API implementations should also only use it for authentication, until advanced locking scenarios have been developed.
3030

3131
## Create Lock
3232

docs/linux-build.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ wheezy. On wheezy it requires `wheezy-backports` versions of `dh-golang`,
2020

2121
## Building an rpm
2222

23-
An rpm package can be built by running ```./rpm/build_rpms.bsh```. All
23+
An rpm package can be built by running ```./rpm/build_rpms.bsh```. All
2424
dependencies will be downloaded, compiled, and installed for you, provided
2525
you have sudo/root permissions. The resulting ./rpm/RPMS/x86_64/git-lfs*.rpm
26-
Can be installed using ```yum install``` or distributed.
26+
Can be installed using ```yum install``` or distributed.
2727

2828
- CentOS 7 - build_rpms.bsh will take care of everything. You only need the
2929
git-lfs rpm

docs/man/git-lfs-update.1.ronn

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ options below.
1414
## OPTIONS
1515

1616
* `--manual` `-m`
17-
Print instructions for manually updating your hooks to include git-lfs
17+
Print instructions for manually updating your hooks to include git-lfs
1818
functionality. Use this option if `git lfs update` fails because of existing
1919
hooks and you want to retain their functionality.
2020

docs/proposals/locking.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ support:
115115

116116
This is useful because it means it provides a reminder that the user should be
117117
locking the file before they start to edit it, to avoid the case of an unexpected
118-
merge later on.
118+
merge later on.
119119

120120
I've done some tests with chmod and discovered:
121121

@@ -151,7 +151,7 @@ I've done some tests with chmod and discovered:
151151
* Calls `post-checkout` with pre/post SHA and branch=1 (even though it's a plain SHA)
152152
* Checkout named files (e.g. discard changes)
153153
* Calls `post-checkout` with identical pre/post SHA (HEAD) and branch=0
154-
* Reset all files (discard all changes ie git reset --hard HEAD)
154+
* Reset all files (discard all changes ie git reset --hard HEAD)
155155
* Doesn't call `post-checkout` - could restore write bit, but must have been
156156
set anyway for file to be edited, so not a problem?
157157
* Reset a branch to a previous commit
@@ -161,7 +161,7 @@ I've done some tests with chmod and discovered:
161161
* Rebase a branch with lockable files (non-conflicting)
162162
* Merge conflicts - fix then commit
163163
* Rebase conflicts - fix then continue
164-
*
164+
*
165165

166166

167167
## Implementation details (Initial simple API-only pass)

0 commit comments

Comments
 (0)