Skip to content

Commit

Permalink
Fix formatting errors in Windows builds steps (#1255)
Browse files Browse the repository at this point in the history
b/281735840

Change-Id: I832793f2d3d1970526cf7b360d03366bbada024f
  • Loading branch information
TyHolc authored Aug 15, 2023
1 parent 4d48a86 commit fbd7069
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions cobalt/site/docs/development/setup-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ into another machine and run the binary on that machine.

<aside class="note">
<b>Note:</b> By default, Cobalt's build system will check
C:\Program Files (x86)\ for the Visual Studio install directory. If you
installed it elsewhere, you can set the `VSINSTALLDIR` environment
<code>C:\Program Files (x86)\</code> for the Visual Studio install directory. If you
installed it elsewhere, you can set the <code>VSINSTALLDIR</code> environment
variable to point to the correct location. For example
`C:/Program Files/Microsoft Visual Studio/2022/Professional`
<code>C:/Program Files/Microsoft Visual Studio/2022/Professional</code>
</aside>

1. Install GN, which we use for our build system code. There are a few ways to
Expand Down Expand Up @@ -63,12 +63,12 @@ into another machine and run the binary on that machine.
```

<aside class="note">
If you plan to contribute to the Cobalt codebase it is recommended that
you create your own
[fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)
of the [Cobalt repository](https://github.com/youtube/cobalt), apply
changes to the fork, and then
[create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
<b>Note:</b> If you plan to contribute to the Cobalt codebase it is
recommended that you create your own
<a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks">fork</a>
of the <a href="https://github.com/youtube/cobalt">Cobalt repository</a>,
apply changes to the fork, and then
<a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork">create a pull request</a>
to merge those changes into the Cobalt repository.
</aside>

Expand Down Expand Up @@ -141,7 +141,8 @@ into another machine and run the binary on that machine.
configuration](/starboard/porting.html#1-enumerate-and-name-your-platform-configurations)
that identifies the platform. As described in the Starboard porting
guide, it contains a `family name` (like `linux`) and a
`binary variant` (like `x64x11`), separated by a hyphen.
`binary variant` (like `x64x11`), separated by a hyphen. For Windows
builds use win-win32.
1. `<build_type>` is the build you are compiling. Possible values are
`debug`, `devel`, `qa`, and `gold`.
1. `<target_name>` is the name assigned to the compiled code and it is
Expand Down Expand Up @@ -222,10 +223,10 @@ and intended to be overwritten by developers creating their own app with Cobalt,
but they should work for local testing.

<aside class="note">
<b>Note:</b> if you change the value of `PUBLISHER` in
`appx_product_settings.py` you <b>must</b> regenerate a pfx file in order for
the packaging step below to work correctly. Follow the instructions in
`starboard/xb1/cert/README.md` to generate your own pfx.
<b>Note:</b> if you change the value of <code>PUBLISHER</code> in
<code>appx_product_settings.py</code> you <b>must</b> regenerate a pfx file in
order for the packaging step below to work correctly. Follow the instructions
in <code>starboard/xb1/cert/README.md</code> to generate your own pfx.
</aside>

### Build Cobalt
Expand Down

0 comments on commit fbd7069

Please sign in to comment.