Skip to content

Move HTML_GIT_CLONE_OPTIONS info into README.md #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2015
Merged

Move HTML_GIT_CLONE_OPTIONS info into README.md #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,15 @@ After you complete the build steps above, the build will run and generate the si
- `multipage/*`

And then you're also ready to edit the `html/source` file—and after you make your changes, you can run the `build.sh` script again to see the new output.

## Options

Your clone doesn't need the HTML standard's complete revision history just for you to build the spec and contribute patches. So, by default we don't start you out with a clone of the history. That makes your first build finish much faster. And if later you decide you do want to clone the complete history, you can still get it, by doing this:
```
cd ./html && git fetch --unshallow
```
That said, if you really do want to *start out* with the complete history of the repo, then run the build script for the first time like this:
```
HTML_GIT_CLONE_OPTIONS="" ./build.sh
```
That will clone the complete history for you. But be warned: It'll make your first build take *dramatically* longer to finish!
18 changes: 0 additions & 18 deletions build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
#!/bin/bash
set -e
# TODO Move the following comment to the README.md file after we review.
# %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %<
# Your clone doesn't need the HTML standard's complete revision history just for
# you to build the spec and contribute patches. So, by default we don't start
# you out with a clone of the history. That makes your first build finish much
# faster. And if later you do decide you do want to clone the complete history,
# you can still get it, by doing this:
#
# git fetch --unshallow
#
# That said, if you really do want to *start out* with the complete history of
# the repo, then run the build script for the first time like this:
#
# HTML_GIT_CLONE_OPTIONS="" ./build.sh
#
# That will clone the complete history for you. But be warned: It'll make your
# first build take *dramatically* longer to finish!
# %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %< %<
HTML_GIT_CLONE_OPTIONS=${HTML_GIT_CLONE_OPTIONS:-"--depth 1"}

# Absolute path to the directory containing this script
Expand Down