Skip to content

Commit f1d7bb5

Browse files
committed
Fixed a bunch of whitespace errors
Fixed a bunch of whitespace errors scattered throughout the repo. Signed-off-by: Dan Horobeanu <[email protected]>
1 parent 33ec902 commit f1d7bb5

20 files changed

+80
-90
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ the terms of the Apache 2.0 license.
1313

1414
## PR Checklist
1515

16-
`[Author TODO: Meet these criteria. Where there are two options, keep one.]`
16+
`[Author TODO: Meet these criteria. Where there are two options, keep one.]`
1717
`[Reviewer TODO: Verify that these criteria are met. Request changes if not]`
1818

1919
- [ ] All commits in this PR are signed (`git commit -s`).
2020
- [ ] Either this PR is linked to an issue, or, the reason for this PR is
21-
clearly provided.
21+
clearly provided.
2222
- [ ] The description of changes is clear and encompassing.
2323
- [ ] Either no docs need to be updated as part of this PR, or, the required
2424
doc changes are included in this PR. Docs in scope are all `*.md` files

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
This project has adopted the
44
[Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
55
For more information see the
6-
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
6+
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
77
88
with any additional questions or comments.

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ commit-based feedback for a contribution, follow the
2323
Firecracker uses the “fork-and-pull” development model. Follow these steps if
2424
you want to merge your changes to Firecracker:
2525

26-
1. Within your fork of
26+
1. Within your fork of
2727
[Firecracker](https://github.com/firecracker-microvm/firecracker), create a
2828
branch for your contribution. Use a meaningful name.
2929
1. Create your contribution, meeting all
@@ -43,7 +43,7 @@ you want to merge your changes to Firecracker:
4343
If you just want to receive feedback for a contribution proposal, open an “RFC”
4444
(“Request for Comments”) pull request:
4545

46-
1. On your fork of
46+
1. On your fork of
4747
[Firecracker](https://github.com/firecracker-microvm/firecracker), create a
4848
branch for the contribution you want feedback on. Use a meaningful name.
4949
1. Create your proposal based on the existing codebase.
@@ -74,4 +74,3 @@ testing. Your contribution needs to meet the following standards:
7474
part of your contribution contravenes this license by signing off on all your
7575
commits with `git -s`. Ensure that every file in your pull request has a
7676
header referring to the repository license file.
77-

FAQ.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ You can see more info about the `refclock` parameters
168168
[here](https://chrony.tuxfamily.org/doc/3.4/chrony.conf.html#refclock).
169169
Adjust them according to your needs.
170170

171-
### Each Firecracker opens 20+ file descriptors. Is this an issue?
171+
### Each Firecracker opens 20+ file descriptors. Is this an issue?
172172

173173
The relatively high FD usage is expected and correct. Firecracker heavily
174174
relies on event file descriptors to drive device emulation.
@@ -230,7 +230,7 @@ Possible mitigations are:
230230

231231
### How can I configure and start a microVM without sending API calls?
232232

233-
Passing an optional command line parameter, `--config-file`, to the Firecracker
234-
process allows this type of configuration. This parameter must be the path to a
235-
file that contains the JSON specification that will be used to configure and start
236-
the microVM. One example of such file can be found at `tests/framework/vm_config.json`.
233+
Passing an optional command line parameter, `--config-file`, to the Firecracker
234+
process allows this type of configuration. This parameter must be the path to a
235+
file that contains the JSON specification that will be used to configure and start
236+
the microVM. One example of such file can be found at `tests/framework/vm_config.json`.

MAINTAINERS.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ Firecracker is maintained by a dedicated team within Amazon:
99
- Dan Horobeanu <[email protected]>
1010
- Diana Popa <[email protected]>
1111
- Andreea Florescu <[email protected]>
12-

NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
Firecracker
2-
Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SECURITY-POLICY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,3 @@ vulnerability during the embargo period.
2020

2121
At the end of the embargo period, maintainers will publicly release information
2222
about the vulnerability together with the Firecracker patches that mitigate it.
23-

SPECIFICATION.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,3 @@ enough RAM, etc.), customers can rely on the following:
5858
³ No logs are currently produced in the span of time between the `jailer`
5959
process start-up and the logging system initialization in the `firecracker`
6060
process.
61-

docs/dev-machine-setup.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -63,22 +63,22 @@ Follow these steps to create a bare metal instance.
6363

6464
1. If you don't already have an AWS account, create one using the [AWS Portal](https://portal.aws.amazon.com/billing/signup).
6565
1. Login to [AWS console](https://console.aws.amazon.com/console/home?region=us-east-1). Bare metal instances are
66-
only supported in `US East (N. Virginia)` region at this time. This
66+
only supported in `US East (N. Virginia)` region at this time. This
6767
region is preselected for you in the Console.
6868
1. Click on `Launch a virtual machine` in `Build Solution` section.
69-
1. Firecracker requires a relatively new kernel, so you should use a recent
69+
1. Firecracker requires a relatively new kernel, so you should use a recent
7070
Linux distribution - such as `Ubuntu Server 18.04 LTS (HVM), SSD Volume Type`.
7171
1. In `Step 2`, scroll to the bottom and select `i3.metal` instance type. Click
7272
on `Next: Configure Instance Details`.
7373
1. In `Step 3`, click on `Next: Add Storage`.
7474
1. In `Step 4`, click on `Next: Add Tags`.
7575
1. In `Step 5`, click on `Next: Configure Security Group`.
76-
1. In `Step 6`, take the default security group. This opens up port 22 and is
76+
1. In `Step 6`, take the default security group. This opens up port 22 and is
7777
needed so that you can ssh into the machine later. Click on `Review and Launch`.
78-
1. Verify the details and click on `Launch`. If you do not have an existing
79-
key pair, then you can select `Create a new key pair` to create a key pair.
78+
1. Verify the details and click on `Launch`. If you do not have an existing
79+
key pair, then you can select `Create a new key pair` to create a key pair.
8080
This is needed so that you can use it later to ssh into the machine.
81-
1. Click on the instance id in the green box. Copy `Public DNS` from the
81+
1. Click on the instance id in the green box. Copy `Public DNS` from the
8282
`Description` tab of the selected instance.
8383
1. Login to the newly created instance:
8484

@@ -99,7 +99,7 @@ you can find brief instructions in the Addendum [below](#addendum).
9999
Here is a brief summary of steps to create such a setup (full instructions to
100100
set up a Ubuntu-based VM on GCE with nested KVM enablement can be found in GCE
101101
[documentation](https://cloud.google.com/compute/docs/instances/enable-nested-virtualization-vm-instances)).
102-
102+
103103
1. Select a GCP project and zone
104104

105105
```
@@ -113,19 +113,19 @@ set up a Ubuntu-based VM on GCE with nested KVM enablement can be found in GCE
113113
It might be convenient to keep your Firecracker-related GCP resources in
114114
a separate project, so that you can keep track of resources more easily
115115
and remove everything easily once your are done.
116-
117-
For convenience, give the project a unique name (e.g.,
116+
117+
For convenience, give the project a unique name (e.g.,
118118
your_name-firecracker), so that GCP does not need to create a project
119119
id different than project name (by appending randomized numbers to the
120120
name you provide).
121-
121+
122122
```
123123
$ gcloud projects create ${FC_PROJECT} --enable-cloud-apis --set-as-default
124124
```
125125
126126
</p>
127127
</details>
128-
128+
129129
```
130130
$ gcloud config set project ${FC_PROJECT}
131131
$ gcloud config set compute/region ${FC_REGION}
@@ -134,7 +134,7 @@ set up a Ubuntu-based VM on GCE with nested KVM enablement can be found in GCE
134134
135135
1. The next step is to create a VM image able to run nested KVM (as outlined
136136
[here](https://cloud.google.com/compute/docs/instances/enable-nested-virtualization-vm-instances)).
137-
137+
138138
**IMPORTANT:** Notice that Firecracker requires a relatively new kernel,
139139
so you should use a recent Linux distribution image - such as Ubuntu 18
140140
(used in the commands below), or equivalent.
@@ -157,19 +157,19 @@ set up a Ubuntu-based VM on GCE with nested KVM enablement can be found in GCE
157157
--image ${FC_IMAGE}
158158
```
159159
160-
1. Connect to the VM via SSH.
160+
1. Connect to the VM via SSH.
161161
162162
```
163163
$ gcloud compute ssh ${FC_VM}
164164
```
165165
166166
When doing it for the first time, a key-pair will be created for you
167167
(you will be propmpted for a passphrase - can just keep it empty) and
168-
uploaded to GCE. Done! You should see the prompt of the new VM:
168+
uploaded to GCE. Done! You should see the prompt of the new VM:
169169
170170
```
171171
ubuntu@firecracker-vm:~$
172-
```
172+
```
173173
174174
1. Verify that VMX is enabled, enable KVM
175175
@@ -180,7 +180,7 @@ set up a Ubuntu-based VM on GCE with nested KVM enablement can be found in GCE
180180
$ [ -r /dev/kvm ] && [ -w /dev/kvm ] && echo "OK" || echo "FAIL"
181181
OK
182182
```
183-
183+
184184
Now you can continue with the Firecracker [Getting Started](getting-started.md)
185185
instructions to install and configure Firecracker in the new VM.
186186
@@ -194,7 +194,7 @@ In a nutshell, setting up a GCP account involves the following steps:
194194
Google credentials. If you don't have account, you will be prompted to join
195195
the trial.
196196
197-
1. Install GCP CLI & SDK (full instructions can be found
197+
1. Install GCP CLI & SDK (full instructions can be found
198198
[here](https://cloud.google.com/sdk/docs/quickstart-debian-ubuntu))
199199
200200
```
@@ -203,7 +203,7 @@ In a nutshell, setting up a GCP account involves the following steps:
203203
| sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
204204
$ curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
205205
$ sudo apt-get update && sudo apt-get install -y google-cloud-sdk
206-
```
206+
```
207207
208208
1. Configure the `gcloud` CLI by running:
209209
@@ -217,4 +217,3 @@ In a nutshell, setting up a GCP account involves the following steps:
217217
### Microsoft Azure
218218
219219
`[TODO]`
220-

docs/getting-started.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -247,24 +247,24 @@ curl --unix-socket /tmp/firecracker.socket -i \
247247

248248
#### Configuring the microVM without sending API requests
249249

250-
If you'd like to boot up a guest machine without using the API socket, you can do that
251-
by passing the parameter `--config-file` to the Firecracker process. The command for
250+
If you'd like to boot up a guest machine without using the API socket, you can do that
251+
by passing the parameter `--config-file` to the Firecracker process. The command for
252252
starting Firecracker with this option will look like this:
253253

254254
```bash
255-
./firecracker --api-sock /tmp/firecracker.socket --config-file
255+
./firecracker --api-sock /tmp/firecracker.socket --config-file
256256
<path_to_the_configuration_file>
257-
```
258-
259-
`path_to_the_configuration_file` should represent the path to a file that contains a
260-
JSON which stores the entire configuration for all of the microVM's resources. The
261-
JSON **must** contain the configuration for the guest kernel and rootfs, as these
262-
are mandatory, but all of the other resources are optional, so it's your choice
263-
if you want to configure them or not. Because using this configuration method will
264-
also start the microVM, you need to specify all desired pre-boot configurable resources
265-
in that JSON. The names of the resources are the ones from the `firecracker.yaml` file
266-
and the names of their fields are the same that are used in API requests.
267-
You can find an example of configuration file at `tests/framework/vm_config.json`.
257+
```
258+
259+
`path_to_the_configuration_file` should represent the path to a file that contains a
260+
JSON which stores the entire configuration for all of the microVM's resources. The
261+
JSON **must** contain the configuration for the guest kernel and rootfs, as these
262+
are mandatory, but all of the other resources are optional, so it's your choice
263+
if you want to configure them or not. Because using this configuration method will
264+
also start the microVM, you need to specify all desired pre-boot configurable resources
265+
in that JSON. The names of the resources are the ones from the `firecracker.yaml` file
266+
and the names of their fields are the same that are used in API requests.
267+
You can find an example of configuration file at `tests/framework/vm_config.json`.
268268
After the machine is booted, you can still use the socket to send API requests
269269
for post-boot operations.
270270

@@ -302,10 +302,10 @@ Within the Firecracker repository root directory:
302302

303303
This will build and place the two Firecracker binaries at:
304304
- `build/cargo_target/${toolchain}/debug/firecracker` and
305-
- `build/cargo_target/${toolchain}/debug/jailer`.
305+
- `build/cargo_target/${toolchain}/debug/jailer`.
306306

307-
The default build profile is `debug`. If you want to build
308-
the release binaries (optimized and stripped of debug info),
307+
The default build profile is `debug`. If you want to build
308+
the release binaries (optimized and stripped of debug info),
309309
use the `--release` option:
310310

311311
```bash

docs/jailer.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ jailer --id <id> \
3939
Firecracker.
4040
- 2 (default): advanced filtering. This adds further checks on some of the
4141
parameters of the allowed syscalls.
42-
- The jailer adheres to the "end of command options" convention, meaning
43-
all parameters specified after `--` are forwarded to Firecracker. For
44-
example, this can be paired with the `--config-file` Firecracker argument to
45-
specify a configuration file when starting Firecracker via the jailer (the
46-
file path and the resources referenced within must be valid relative to a
47-
jailed Firecracker). Please note the jailer already passes the following
48-
parameters to the Firecracker process: `--api-sock`, `--seccomp-level` and
42+
- The jailer adheres to the "end of command options" convention, meaning
43+
all parameters specified after `--` are forwarded to Firecracker. For
44+
example, this can be paired with the `--config-file` Firecracker argument to
45+
specify a configuration file when starting Firecracker via the jailer (the
46+
file path and the resources referenced within must be valid relative to a
47+
jailed Firecracker). Please note the jailer already passes the following
48+
parameters to the Firecracker process: `--api-sock`, `--seccomp-level` and
4949
`--id`.
5050

5151
## Jailer Operation

docs/mmds.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ the data store, and the minimalist HTTP/TCP/IPv4 stack (named *Dumbo*). They
77
all exist within the Firecracker process, and outside the KVM boundary; the
88
first is a part of the API server, the data store is a global entity for a
99
single microVM, and the last is a part of the device model.
10-
When the API server is disabled by passing `--no-api` parameter to Firecracker,
11-
MMDS is no longer available.
10+
When the API server is disabled by passing `--no-api` parameter to Firecracker,
11+
MMDS is no longer available.
1212

1313
## The MMDS backend
1414

docs/rootfs-and-kernel-setup.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,26 @@ can boot:
1717
git clone https://github.com/torvalds/linux.git linux.git
1818
cd linux.git
1919
```
20-
20+
2121
2. Check out the Linux version you want to build (e.g. we'll be using v4.20
2222
here):
23-
23+
2424
```bash
2525
git checkout v4.20
2626
```
27-
27+
2828
3. You will need to configure your Linux build. You can start from
2929
[our recommended config](../resources/microvm-kernel-config) - just copy
3030
it to `.config` (under the Linux sources dir). You can make interactive
3131
config adjustments using:
32-
32+
3333
```bash
3434
make menuconfig
3535
```
36-
36+
3737
*Note*: there are many ways of building a kernel config file, other than
3838
`menuconfig`. You are free to use whichever one you choose.
39-
39+
4040
4. Build the uncompressed kernel image:
4141

4242
```bash
@@ -58,11 +58,11 @@ at boot time.
5858
To build an EXT4 image:
5959
1. Prepare a properly-sized file. We'll use 50MiB here, but this depends
6060
on how much data you'll want to fit inside:
61-
61+
6262
```bash
6363
dd if=/dev/zero of=/rootfs.ext4 bs=1M count=50
6464
```
65-
65+
6666
2. Create an empty file system on the file you created:
6767

6868
```bash
@@ -109,12 +109,12 @@ Alpine Linux:
109109
ln -s agetty /etc/init.d/agetty.ttyS0
110110
echo ttyS0 > /etc/securetty
111111
rc-update add agetty.ttyS0 default
112-
112+
113113
# Make sure special file systems are mounted on boot:
114114
rc-update add devfs boot
115115
rc-update add procfs boot
116116
rc-update add sysfs boot
117-
117+
118118
# Then, copy the newly configured system to the rootfs image:
119119
for d in bin etc lib root sbin usr; do tar c "/$d" | tar x -C /my-rootfs; done
120120
for dir in dev proc run sys var; do mkdir /my-rootfs/${dir}; done
@@ -131,4 +131,3 @@ Alpine Linux:
131131

132132
You should now have a kernel image (`vmlinux`) and a rootfs image
133133
(`rootfs.ext4`), that you can boot with Firecracker.
134-

docs/vsock.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Firecracker vsock device aims to provide full virtio-vsock support to
2222
software running inside the guest VM, while bypassing vhost kernel code on the
2323
host. To that end, Firecracker implements the virtio-vsock device model, and
2424
mediates communication between AF_UNIX sockets (on the host end) and AF_VSOCK
25-
sockets (on the guest end).
25+
sockets (on the guest end).
2626

2727
In order to provide channel multiplexing, AF_VSOCK ports are translated into
2828
multiple AF_UNIX sockets (one Unix socket per vsock port). The virtio-vsock

src/arch_gen/Cargo.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@ version = "0.1.0"
44
authors = ["Amazon Firecracker team <[email protected]>"]
55

66
[dependencies]
7-

src/virtio_gen/patches/0001-virtio_gen-remove-derive-Debug-from-packed-struct.patch

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,5 @@ index 0b68d09..a1c9dca 100644
2626
pub struct virtio_net_ctrl_mac {
2727
pub entries: __virtio32,
2828
pub macs: __IncompleteArrayField<[__u8; 6usize]>,
29-
--
29+
--
3030
2.7.4
31-

0 commit comments

Comments
 (0)