{"action":"created","comment":{"url":"https://api.github.com/repos/coreos/rkt/pulls/comments/46807848","id":46807848,"diff_hunk":"@@ -0,0 +1,137 @@\n+# Build configuration\n+\n+## Overview\n+\n+This file describes all the parameters of the configure script and their possible uses.\n+For a quick help of available parameters, run `./configure --help`.\n+\n+## Parameters for building stage1 flavors\n+\n+#### `--with-stage1-flavors`\n+\n+This parameter takes a comma-separated list of all the flavors that the build system should assemble.\n+Depending on a default stage1 image setup, this list is by default either empty or set to `coreos,kvm` for, respectively, detailed setup and flavor setup.\n+Note that specifying this parameter does not necessarily means that rkt will use them in the end.\n+Available flavors are:\n+\n+- `coreos` - it takes systemd and bash from CoreOS PXE image; uses systemd-nspawn\n+- `kvm` - it takes systemd, bash and other binaries from CoreOS PXE image; uses lkvm\n+- `src` - it builds systemd, takes bash from host at build time; uses built systemd-nspawn\n+- `host` - it takes systemd and bash from host at runtime; uses systemd-nspawn from host\n+\n+The `host` flavor is probably best suited flavor for distributions that have strict rules about software sources.\n+\n+#### `--with-stage1-flavors-version-override`\n+\n+This parameter takes a version number to become a version of all the built flavors of stage1 image.\n+Normally, without this parameter, the images have the same version as rkt itself.\n+This parameter may be useful for distributions that often provide patched versions of upstream software without changing major/minor/patch version number, but instead add a numeric suffix.\n+An example usage could be passing `--with-stage1-flavors-version-override=0.12.0-2`, so the new image will have a version `0.12.0-2` instead of `0.12.0`.\n+This parameter also affects default stage1 image version in flavor setup.\n+\n+## Parameters for setting up default stage1 image\n+\n+The parameters described below affects handling of default stage1 image by rkt.\n+rkt first tries to find the stage1 image in the store by using the default stage1 image name and version.\n+If this fails, rkt will try to fetch the image into the store from the default stage1 image location.\n+\n+There are two mutually exclusive ways to specify a default stage1 image name and version:\n+\n+- flavor setup\n+- detailed setup\n+\n+### Flavor setup\n+\n+Flavor setup has only one parameter.\n+This kind of a setup is rather a convenience wrapper around the detailed setup.\n+\n+#### `--with-stage1-default-flavor`\n+\n+It takes a name of the flavor of the stage1 image we build and, based on that, it sets up the default stage1 image name and version.\n+Default stage1 image in this case is often something like coreos.com/rkt/stage1-<name of the flavor>.\n+Default stage1 version is usually just rkt version, unless it is overridden with `--with-stage1-flavors-version-override`.\n+This is the default setup if neither flavor nor detailed setup are used.\n+The default stage1 image flavor is the first flavor on the list in `--with-stage1-flavors`.\n+\n+### Detailed setup\n+\n+Detailed setup has two parameters, both must be provided.\n+This kind of a setup could be used to make some 3rd party stage1 implementation the default stage1 image used by rkt.\n+\n+#### `--with-stage1-default-name`\n+\n+This parameter tells what is the name of the default stage1 image.\n+\n+#### `--with-stage1-default-version`\n+\n+This parameter tells what is the version of the default stage1 image.\n+\n+### Location of the default stage1 image\n+\n+#### `--with-stage1-default-location`\n+\n+This parameter tells rkt where to find the default stage1 image if it is not found in the store.\n+For the detailed setup, the default value of this parameter is empty, so if it is not provided, you may be forced to inform rkt about the location of stage1 image at runtime.\n+For the flavor setup, the default value is a special relative path, telling rkt to look for the image in the same directory as it itself.\n+Normally, this parameter should be specified to some URL, with or without a scheme.","path":"Documentation/build-configure.md","position":76,"original_position":76,"commit_id":"b5355aa35922d003cfd8a35f4c65ff3b7dfac843","original_commit_id":"b5355aa35922d003cfd8a35f4c65ff3b7dfac843","user":{"login":"iaguis","id":507354,"avatar_url":"https://avatars.githubusercontent.com/u/507354?v=3","gravatar_id":"","url":"https://api.github.com/users/iaguis","html_url":"https://github.com/iaguis","followers_url":"https://api.github.com/users/iaguis/followers","following_url":"https://api.github.com/users/iaguis/following{/other_user}","gists_url":"https://api.github.com/users/iaguis/gists{/gist_id}","starred_url":"https://api.github.com/users/iaguis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/iaguis/subscriptions","organizations_url":"https://api.github.com/users/iaguis/orgs","repos_url":"https://api.github.com/users/iaguis/repos","events_url":"https://api.github.com/users/iaguis/events{/privacy}","received_events_url":"https://api.github.com/users/iaguis/received_events","type":"User","site_admin":false},"body":"s/should be specified to/should be/","created_at":"2015-12-07T10:53:07Z","updated_at":"2015-12-07T10:53:07Z","html_url":"https://github.com/coreos/rkt/pull/1821#discussion_r46807848","pull_request_url":"https://api.github.com/repos/coreos/rkt/pulls/1821","_links":{"self":{"href":"https://api.github.com/repos/coreos/rkt/pulls/comments/46807848"},"html":{"href":"https://github.com/coreos/rkt/pull/1821#discussion_r46807848"},"pull_request":{"href":"https://api.github.com/repos/coreos/rkt/pulls/1821"}}},"pull_request":{"url":"https://api.github.com/repos/coreos/rkt/pulls/1821","id":52279917,"html_url":"https://github.com/coreos/rkt/pull/1821","diff_url":"https://github.com/coreos/rkt/pull/1821.diff","patch_url":"https://github.com/coreos/rkt/pull/1821.patch","issue_url":"https://api.github.com/repos/coreos/rkt/issues/1821","number":1821,"state":"open","locked":false,"title":"build: Allow packagers to override stage1 version","user":{"login":"krnowak","id":96081,"avatar_url":"https://avatars.githubusercontent.com/u/96081?v=3","gravatar_id":"","url":"https://api.github.com/users/krnowak","html_url":"https://github.com/krnowak","followers_url":"https://api.github.com/users/krnowak/followers","following_url":"https://api.github.com/users/krnowak/following{/other_user}","gists_url":"https://api.github.com/users/krnowak/gists{/gist_id}","starred_url":"https://api.github.com/users/krnowak/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/krnowak/subscriptions","organizations_url":"https://api.github.com/users/krnowak/orgs","repos_url":"https://api.github.com/users/krnowak/repos","events_url":"https://api.github.com/users/krnowak/events{/privacy}","received_events_url":"https://api.github.com/users/krnowak/received_events","type":"User","site_admin":false},"body":"Fixes #1813.","created_at":"2015-12-01T16:24:39Z","updated_at":"2015-12-07T10:53:07Z","closed_at":null,"merged_at":null,"merge_commit_sha":"cb128a6e47904cd68e4c99eef27b86d5419b8b5e","assignee":null,"milestone":{"url":"https://api.github.com/repos/coreos/rkt/milestones/25","html_url":"https://github.com/coreos/rkt/milestones/v0.14.0","labels_url":"https://api.github.com/repos/coreos/rkt/milestones/25/labels","id":1408793,"number":25,"title":"v0.14.0","description":"","creator":{"login":"alban","id":27575,"avatar_url":"https://avatars.githubusercontent.com/u/27575?v=3","gravatar_id":"","url":"https://api.github.com/users/alban","html_url":"https://github.com/alban","followers_url":"https://api.github.com/users/alban/followers","following_url":"https://api.github.com/users/alban/following{/other_user}","gists_url":"https://api.github.com/users/alban/gists{/gist_id}","starred_url":"https://api.github.com/users/alban/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alban/subscriptions","organizations_url":"https://api.github.com/users/alban/orgs","repos_url":"https://api.github.com/users/alban/repos","events_url":"https://api.github.com/users/alban/events{/privacy}","received_events_url":"https://api.github.com/users/alban/received_events","type":"User","site_admin":false},"open_issues":41,"closed_issues":17,"state":"open","created_at":"2015-11-12T16:51:31Z","updated_at":"2015-12-07T09:38:31Z","due_on":"2015-12-09T23:00:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/coreos/rkt/pulls/1821/commits","review_comments_url":"https://api.github.com/repos/coreos/rkt/pulls/1821/comments","review_comment_url":"https://api.github.com/repos/coreos/rkt/pulls/comments{/number}","comments_url":"https://api.github.com/repos/coreos/rkt/issues/1821/comments","statuses_url":"https://api.github.com/repos/coreos/rkt/statuses/b5355aa35922d003cfd8a35f4c65ff3b7dfac843","head":{"label":"kinvolk:krnowak/override-stage1-version","ref":"krnowak/override-stage1-version","sha":"b5355aa35922d003cfd8a35f4c65ff3b7dfac843","user":{"login":"kinvolk","id":14073052,"avatar_url":"https://avatars.githubusercontent.com/u/14073052?v=3","gravatar_id":"","url":"https://api.github.com/users/kinvolk","html_url":"https://github.com/kinvolk","followers_url":"https://api.github.com/users/kinvolk/followers","following_url":"https://api.github.com/users/kinvolk/following{/other_user}","gists_url":"https://api.github.com/users/kinvolk/gists{/gist_id}","starred_url":"https://api.github.com/users/kinvolk/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kinvolk/subscriptions","organizations_url":"https://api.github.com/users/kinvolk/orgs","repos_url":"https://api.github.com/users/kinvolk/repos","events_url":"https://api.github.com/users/kinvolk/events{/privacy}","received_events_url":"https://api.github.com/users/kinvolk/received_events","type":"Organization","site_admin":false},"repo":{"id":45149715,"name":"rkt","full_name":"kinvolk/rkt","owner":{"login":"kinvolk","id":14073052,"avatar_url":"https://avatars.githubusercontent.com/u/14073052?v=3","gravatar_id":"","url":"https://api.github.com/users/kinvolk","html_url":"https://github.com/kinvolk","followers_url":"https://api.github.com/users/kinvolk/followers","following_url":"https://api.github.com/users/kinvolk/following{/other_user}","gists_url":"https://api.github.com/users/kinvolk/gists{/gist_id}","starred_url":"https://api.github.com/users/kinvolk/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kinvolk/subscriptions","organizations_url":"https://api.github.com/users/kinvolk/orgs","repos_url":"https://api.github.com/users/kinvolk/repos","events_url":"https://api.github.com/users/kinvolk/events{/privacy}","received_events_url":"https://api.github.com/users/kinvolk/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/kinvolk/rkt","description":"rkt is an App Container runtime for Linux","fork":true,"url":"https://api.github.com/repos/kinvolk/rkt","forks_url":"https://api.github.com/repos/kinvolk/rkt/forks","keys_url":"https://api.github.com/repos/kinvolk/rkt/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kinvolk/rkt/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kinvolk/rkt/teams","hooks_url":"https://api.github.com/repos/kinvolk/rkt/hooks","issue_events_url":"https://api.github.com/repos/kinvolk/rkt/issues/events{/number}","events_url":"https://api.github.com/repos/kinvolk/rkt/events","assignees_url":"https://api.github.com/repos/kinvolk/rkt/assignees{/user}","branches_url":"https://api.github.com/repos/kinvolk/rkt/branches{/branch}","tags_url":"https://api.github.com/repos/kinvolk/rkt/tags","blobs_url":"https://api.github.com/repos/kinvolk/rkt/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kinvolk/rkt/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kinvolk/rkt/git/refs{/sha}","trees_url":"https://api.github.com/repos/kinvolk/rkt/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kinvolk/rkt/statuses/{sha}","languages_url":"https://api.github.com/repos/kinvolk/rkt/languages","stargazers_url":"https://api.github.com/repos/kinvolk/rkt/stargazers","contributors_url":"https://api.github.com/repos/kinvolk/rkt/contributors","subscribers_url":"https://api.github.com/repos/kinvolk/rkt/subscribers","subscription_url":"https://api.github.com/repos/kinvolk/rkt/subscription","commits_url":"https://api.github.com/repos/kinvolk/rkt/commits{/sha}","git_commits_url":"https://api.github.com/repos/kinvolk/rkt/git/commits{/sha}","comments_url":"https://api.github.com/repos/kinvolk/rkt/comments{/number}","issue_comment_url":"https://api.github.com/repos/kinvolk/rkt/issues/comments{/number}","contents_url":"https://api.github.com/repos/kinvolk/rkt/contents/{+path}","compare_url":"https://api.github.com/repos/kinvolk/rkt/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kinvolk/rkt/merges","archive_url":"https://api.github.com/repos/kinvolk/rkt/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kinvolk/rkt/downloads","issues_url":"https://api.github.com/repos/kinvolk/rkt/issues{/number}","pulls_url":"https://api.github.com/repos/kinvolk/rkt/pulls{/number}","milestones_url":"https://api.github.com/repos/kinvolk/rkt/milestones{/number}","notifications_url":"https://api.github.com/repos/kinvolk/rkt/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kinvolk/rkt/labels{/name}","releases_url":"https://api.github.com/repos/kinvolk/rkt/releases{/id}","created_at":"2015-10-29T00:17:06Z","updated_at":"2015-10-29T00:17:09Z","pushed_at":"2015-12-07T10:38:13Z","git_url":"git://github.com/kinvolk/rkt.git","ssh_url":"git@github.com:kinvolk/rkt.git","clone_url":"https://github.com/kinvolk/rkt.git","svn_url":"https://github.com/kinvolk/rkt","homepage":"","size":17898,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"coreos:master","ref":"master","sha":"4a67d68061cbc1fecf48c81b7537a2f858ec66ff","user":{"login":"coreos","id":3730757,"avatar_url":"https://avatars.githubusercontent.com/u/3730757?v=3","gravatar_id":"","url":"https://api.github.com/users/coreos","html_url":"https://github.com/coreos","followers_url":"https://api.github.com/users/coreos/followers","following_url":"https://api.github.com/users/coreos/following{/other_user}","gists_url":"https://api.github.com/users/coreos/gists{/gist_id}","starred_url":"https://api.github.com/users/coreos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coreos/subscriptions","organizations_url":"https://api.github.com/users/coreos/orgs","repos_url":"https://api.github.com/users/coreos/repos","events_url":"https://api.github.com/users/coreos/events{/privacy}","received_events_url":"https://api.github.com/users/coreos/received_events","type":"Organization","site_admin":false},"repo":{"id":26509369,"name":"rkt","full_name":"coreos/rkt","owner":{"login":"coreos","id":3730757,"avatar_url":"https://avatars.githubusercontent.com/u/3730757?v=3","gravatar_id":"","url":"https://api.github.com/users/coreos","html_url":"https://github.com/coreos","followers_url":"https://api.github.com/users/coreos/followers","following_url":"https://api.github.com/users/coreos/following{/other_user}","gists_url":"https://api.github.com/users/coreos/gists{/gist_id}","starred_url":"https://api.github.com/users/coreos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coreos/subscriptions","organizations_url":"https://api.github.com/users/coreos/orgs","repos_url":"https://api.github.com/users/coreos/repos","events_url":"https://api.github.com/users/coreos/events{/privacy}","received_events_url":"https://api.github.com/users/coreos/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/coreos/rkt","description":"rkt is an App Container runtime for Linux","fork":false,"url":"https://api.github.com/repos/coreos/rkt","forks_url":"https://api.github.com/repos/coreos/rkt/forks","keys_url":"https://api.github.com/repos/coreos/rkt/keys{/key_id}","collaborators_url":"https://api.github.com/repos/coreos/rkt/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/coreos/rkt/teams","hooks_url":"https://api.github.com/repos/coreos/rkt/hooks","issue_events_url":"https://api.github.com/repos/coreos/rkt/issues/events{/number}","events_url":"https://api.github.com/repos/coreos/rkt/events","assignees_url":"https://api.github.com/repos/coreos/rkt/assignees{/user}","branches_url":"https://api.github.com/repos/coreos/rkt/branches{/branch}","tags_url":"https://api.github.com/repos/coreos/rkt/tags","blobs_url":"https://api.github.com/repos/coreos/rkt/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/coreos/rkt/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/coreos/rkt/git/refs{/sha}","trees_url":"https://api.github.com/repos/coreos/rkt/git/trees{/sha}","statuses_url":"https://api.github.com/repos/coreos/rkt/statuses/{sha}","languages_url":"https://api.github.com/repos/coreos/rkt/languages","stargazers_url":"https://api.github.com/repos/coreos/rkt/stargazers","contributors_url":"https://api.github.com/repos/coreos/rkt/contributors","subscribers_url":"https://api.github.com/repos/coreos/rkt/subscribers","subscription_url":"https://api.github.com/repos/coreos/rkt/subscription","commits_url":"https://api.github.com/repos/coreos/rkt/commits{/sha}","git_commits_url":"https://api.github.com/repos/coreos/rkt/git/commits{/sha}","comments_url":"https://api.github.com/repos/coreos/rkt/comments{/number}","issue_comment_url":"https://api.github.com/repos/coreos/rkt/issues/comments{/number}","contents_url":"https://api.github.com/repos/coreos/rkt/contents/{+path}","compare_url":"https://api.github.com/repos/coreos/rkt/compare/{base}...{head}","merges_url":"https://api.github.com/repos/coreos/rkt/merges","archive_url":"https://api.github.com/repos/coreos/rkt/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/coreos/rkt/downloads","issues_url":"https://api.github.com/repos/coreos/rkt/issues{/number}","pulls_url":"https://api.github.com/repos/coreos/rkt/pulls{/number}","milestones_url":"https://api.github.com/repos/coreos/rkt/milestones{/number}","notifications_url":"https://api.github.com/repos/coreos/rkt/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/coreos/rkt/labels{/name}","releases_url":"https://api.github.com/repos/coreos/rkt/releases{/id}","created_at":"2014-11-11T23:13:18Z","updated_at":"2015-12-07T09:00:42Z","pushed_at":"2015-12-07T10:39:55Z","git_url":"git://github.com/coreos/rkt.git","ssh_url":"git@github.com:coreos/rkt.git","clone_url":"https://github.com/coreos/rkt.git","svn_url":"https://github.com/coreos/rkt","homepage":"","size":21531,"stargazers_count":4910,"watchers_count":4910,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":418,"mirror_url":null,"open_issues_count":198,"forks":418,"open_issues":198,"watchers":4910,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/coreos/rkt/pulls/1821"},"html":{"href":"https://github.com/coreos/rkt/pull/1821"},"issue":{"href":"https://api.github.com/repos/coreos/rkt/issues/1821"},"comments":{"href":"https://api.github.com/repos/coreos/rkt/issues/1821/comments"},"review_comments":{"href":"https://api.github.com/repos/coreos/rkt/pulls/1821/comments"},"review_comment":{"href":"https://api.github.com/repos/coreos/rkt/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/coreos/rkt/pulls/1821/commits"},"statuses":{"href":"https://api.github.com/repos/coreos/rkt/statuses/b5355aa35922d003cfd8a35f4c65ff3b7dfac843"}}}}