-
Notifications
You must be signed in to change notification settings - Fork 347
Skip post-book actions if we can #673
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.
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
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
6a172b0
Skip post-book actions if we can
nik9000 908fa0a
Remove testing hack
nik9000 512856f
Merge branch 'master' into noise
nik9000 aad32b7
Test
nik9000 4237f0b
Merge branch 'master' into noise
nik9000 bf0eae4
-q
nik9000 d33586e
Merge branch 'master' into noise
nik9000 a19ed70
Explain
nik9000 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# This is a small config file for build_docs.pl used for testing | ||
|
||
# This block is required even when building a single doc | ||
template: | ||
path: .template/ | ||
branch: | ||
default: | ||
base_url: 'https://www.elastic.co/' | ||
template_url: 'https://www.elastic.co/guide_template' | ||
staging: | ||
base_url: 'https://stag-www.elastic.co/' | ||
template_url: 'https://stag-www.elastic.co/guide_template' | ||
defaults: | ||
POSTHEAD: | | ||
<link rel="stylesheet" type="text/css" href="styles.css" /> | ||
FINAL: | | ||
<script type="text/javascript" src="docs.js"></script> | ||
<script type='text/javascript' src='https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js?lang=yaml'></script> | ||
|
||
paths: | ||
# These two configure where to put things in the --target_repo. The | ||
# paths are resolved relative to the root of the --target_repo. | ||
build: html/ | ||
branch_tracker: html/branches.yaml | ||
# This configures which directory to use for cloning repos. Because | ||
# these are big we tend to want them to be in a non-temporary but | ||
# .gitignored spot. The path is resolved relative to the root of the | ||
# docs repo. | ||
repos: --tmp--/repos/ | ||
|
||
# This configures all of the repositories used to build the docs | ||
repos: | ||
# Normally we use the `https://` prefix to clone from github but this file | ||
# is for testing so use a string that we can find with sed and replace with | ||
# a file. | ||
source: --tmp--/source | ||
|
||
# The title to use for the table of contents | ||
contents_title: Elastic Stack and Product Documentation | ||
|
||
# The actual books to build | ||
contents: | ||
- | ||
title: Test book | ||
prefix: test | ||
current: master | ||
branches: [ master, prev ] | ||
index: docs/index.asciidoc | ||
tags: test tag | ||
subject: Test | ||
sources: | ||
- | ||
repo: source | ||
path: docs/index.asciidoc |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the
false
return the most important factor here, or the text output?To put it another way, is this function
assert_not_in_file
orprint_file_if_unmatched
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
assert_not_in_file
. But I need to print the file so I can figure out what is going on.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think
assert_not_in_file
is a better name for this? I'm so used to thinking aboutgrep -v
but the output on failure is different.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it's a big deal, but after reading the function name and the comment, I still wasn't sure which part of the function was the core and which was the side-effect. It's not a big public API, so just tweaking the comment a bit would probably be fine, too.
I don't love the name
GREP_V
, because it reveals the implementation, but again, this a Makefile, not some hallowed, live-with-it-forever public API.My question was mostly to satisfy my curiosity, rather than to demand changes.