Skip to content
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

Preparation for 4.0.10 (stable-4.0) #13704

Merged
merged 87 commits into from
Jul 10, 2024
Merged
Changes from 1 commit
Commits
Show all changes
87 commits
Select commit Hold shift + click to select a range
d46d4ac
lxd/devlxd: Don't expand format strings
stgraber Apr 12, 2022
bc8f74f
lxd/instance/qemu: Set spawn=allow
stgraber Mar 7, 2022
b7478f9
*: mass rename github.com/lxc/lxd -> github.com/canonical/lxd
simondeziel Jul 5, 2024
f7bda31
Makefile: Pin xgettext-go to working version
stgraber Aug 20, 2022
55ab7ee
Makefile: pin raft to a specific SHA1 commit
simondeziel Jun 20, 2024
fce9cee
Makefile: pin dqlite to a specific SHA1 commit
simondeziel Jun 20, 2024
e6d6c2b
lxd: Update instance types URL
simondeziel Jun 20, 2024
d815ef9
github: the sphinx config moved to doc/
simondeziel Aug 2, 2023
1d1db47
github: Update for new labeler
stgraber Dec 4, 2023
b18b7a1
github: add labels when PRs target LTS branches
simondeziel Feb 14, 2024
136efff
lxc/config/default: Remove images remote
MusicDin Jan 18, 2024
36f2e94
lxc/config/default: Add images remote for images.lxd.canonical.com
tomponline Apr 2, 2024
7dfc58d
lxd/config/default: Add images to DefaultRemotes
tomponline Apr 12, 2024
cfbdeef
*: replace images.linuxcontainers.org by images.lxd.canonical.com
simondeziel Jun 20, 2024
bb5213c
test: Flush routes on lo interface left over from liblxc ipvlan bug
tomponline Jun 24, 2024
ccebbda
test: Fix container devices nic bridged filtering tests on recent ver…
tomponline Mar 14, 2022
91d9fc3
lxd/instance/drivers/driver/lxc: Add support for disabling idmapped m…
tomponline Jun 24, 2024
45e5640
test: Fix manual shifting protection tests by disabling kernel shifting
tomponline Sep 27, 2022
fd484ee
test: Order client dependencies alphabetically.
markylaing Jun 24, 2024
23945a9
*: Runs `gofmt -w -s ./`.
markylaing Jun 24, 2024
e8ffa10
github: adapt snap build job from main branch
simondeziel Jun 25, 2024
c5efb78
lxd/config: Add ubuntu-minimal and ubuntu-minimal-daily remotes
MusicDin Sep 4, 2023
2c7a5b7
lxd-benchmark: Use image from ubuntu remote in description
MusicDin Jan 18, 2024
21b5121
github: Update for current min Go version (1.16)
stgraber Feb 10, 2022
0ff6cda
doc: Clarify multiple GPU device passthrough for VMs.
markylaing Feb 3, 2022
ea61107
doc: Add basic instance exec information
stgraber Feb 3, 2022
bda5281
doc: use local image
ru-fu Feb 8, 2022
eeb02ce
doc/instances: Removes trailing whitespace
tomponline Feb 24, 2022
4eaa8d1
doc: Update for new myst_parser
stgraber Jun 8, 2022
8856638
doc: move .sphinx directory and conf.py file
ru-fu Jun 15, 2023
d2122fd
doc: add a .readthedocs.yaml file
ru-fu Jun 19, 2023
b3162a8
doc: move requirement setup from the Makefile to conf.py
ru-fu Jun 19, 2023
0baf35a
doc: hide the version selector on RTD
ru-fu Jun 19, 2023
99d2a44
doc: fix styling of version box on RTD
ru-fu Jun 20, 2023
3fbe256
doc: add a 404 page
ru-fu Jul 4, 2023
32d3da1
doc: update header
ru-fu Jul 4, 2023
9bb208c
doc: update links
ru-fu Jul 3, 2023
9a5a2e4
doc: update header for mobile compatibility
edlerd Jul 5, 2023
d3d0ec4
doc: Update links to new locations
tomponline Jul 5, 2023
a4dd659
doc: changes to make the build work
ru-fu Jul 5, 2023
1e10787
doc: fix symbolic link to rest-api.yaml after moving the directory
ru-fu Jun 19, 2023
5e10ce3
doc: fix indentation in rest-api.yaml
ru-fu Oct 20, 2023
f613cf4
doc: add doc output to "make dist"
ru-fu Feb 8, 2022
31c5ede
doc: use newer Sphinx version
ru-fu Dec 14, 2022
433d193
doc: fix the footer
ru-fu Feb 23, 2022
567b658
doc: update footer to display correctly
ru-fu Sep 16, 2022
02a4061
code of conduct: update email address
ru-fu Jul 5, 2023
80f290e
build(deps): bump actions/labeler from 3 to 4
dependabot[bot] Nov 27, 2023
e307876
build(deps): bump actions/upload-artifact from 2 to 3
dependabot[bot] Nov 27, 2023
e19c420
build(deps): bump actions/setup-go from 2 to 4
dependabot[bot] Nov 27, 2023
291d513
build(deps): bump actions/checkout from 2 to 4
dependabot[bot] Nov 27, 2023
9f369f0
build(deps): bump actions/labeler from 4 to 5
dependabot[bot] Dec 5, 2023
7cfe797
build(deps): bump actions/setup-go from 4 to 5
dependabot[bot] Dec 11, 2023
a64a116
build(deps): bump actions/upload-artifact from 3 to 4
dependabot[bot] Dec 18, 2023
d78f86b
README: change the branch for the GitHub badges
ru-fu Jul 6, 2023
894ea3e
README: remove link to CII Best Practices
simondeziel Jul 5, 2024
8266c03
README: update link to tests status badge
simondeziel Jul 5, 2024
3a485ab
README: remove link to CI server status badge (not tested yet)
simondeziel Jul 5, 2024
0d4292c
SECURITY.md: update security policy
ru-fu Jul 4, 2023
0537e9f
lxd/migrate: update link to doc (new path and branch name)
simondeziel Jul 7, 2023
b12476e
doc/security: update link for main branch
simondeziel Jul 5, 2024
b63bb53
CONTRIBUTING: update link for main branch
simondeziel Jul 5, 2024
fe799c6
Makefile: Update translation bugs email address.
markylaing Jul 6, 2023
2caf285
Makefile: support setting a custom version for `make dist`
simondeziel Jul 9, 2024
15a9081
Makefile: use go install instead of go get
simondeziel Jul 9, 2024
7fc3603
po: Run `LXD_OFFLINE=1 make update-pot`
simondeziel Jul 5, 2024
259846e
po: Run `make update-po`
simondeziel Jul 5, 2024
dd2a7c9
doc/metadata: Drop now unused file
simondeziel Jul 10, 2023
144c1ea
doc/requirements: bump Go min to 1.16
simondeziel Jul 9, 2024
0b3fcdc
test: drop dependency on uuidgen
simondeziel Apr 11, 2022
82d084e
test/backends: sync with main branch
simondeziel Jul 9, 2024
8d6a60c
test/backends/lvm: use bigger loop dev to accomodate for metadata LV
simondeziel Jul 9, 2024
2514af5
test/includes: sync with main branch
simondeziel Jul 9, 2024
f202888
test/main: sync with main branch
simondeziel Jul 9, 2024
9f475d4
github: sync triage workflow with main branch
simondeziel Jul 9, 2024
3493ec8
github: sync tests workflow with main branch
simondeziel Jul 9, 2024
22cec9f
github: remove sphinx workflow (moved to tests)
simondeziel Jul 9, 2024
a412902
test: update shellcheck disable code
simondeziel Jul 9, 2024
0debb9a
test/suites/static_analysis: ignore some suggestions from shellcheck
simondeziel Jul 9, 2024
e173b9e
test/suites/static_analysis: disable go vet
simondeziel Jul 10, 2024
6fa1631
test/suites/static_analysis: skip doc/ directory
simondeziel Jul 9, 2024
ec3cfa4
github: make sure xgettext-go is available during offline build
simondeziel Jul 9, 2024
e3bb6da
test/suites/storage: tune quota values
simondeziel Jul 9, 2024
cb3ec71
test/suites/migration: skip optimized btrfs->btrfs migration
simondeziel Jul 9, 2024
5815123
test: BTRFS nospace_cache usage was failing to mount on 5.19.0-43-gen…
tomponline May 31, 2023
e7a6c3b
test/suites/storage_driver_btrfs: don't test copy between pools
simondeziel Jul 10, 2024
b31ae68
test/suites/storage_driver_btrfs: skip --optimized-storage test
simondeziel Jul 10, 2024
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
Prev Previous commit
Next Next commit
doc: move .sphinx directory and conf.py file
Move the Sphinx configuration files to a more standard location.

Signed-off-by: Ruth Fuchss <[email protected]>
(cherry picked from commit ef0923e)
Signed-off-by: Simon Deziel <[email protected]>
ru-fu authored and simondeziel committed Jul 9, 2024
commit 8856638b1bbf6ad56cd7586dc8cca51a704ba401
2 changes: 1 addition & 1 deletion .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ jobs:
run: make doc

- name: Print warnings
run: if [ -s .sphinx/warnings.txt ]; then cat .sphinx/warnings.txt; exit 1; fi
run: if [ -s doc/.sphinx/warnings.txt ]; then cat doc/.sphinx/warnings.txt; exit 1; fi

- name: Upload artifacts
if: always()
11 changes: 6 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -18,11 +18,12 @@ test/macaroon-identity/macaroon-identity

# Sphinx
doc/html/
.sphinx/deps/
.sphinx/themes/
.sphinx/venv/
.sphinx/warnings.txt
.sphinx/_static/swagger-ui
doc/.sphinx/deps/
doc/.sphinx/themes/
doc/.sphinx/venv/
doc/.sphinx/warnings.txt
doc/.sphinx/_static/swagger-ui
doc/.sphinx/_static/download

# For Atom ctags
.tags
17 changes: 9 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ HASH := \#
TAG_SQLITE3=$(shell printf "$(HASH)include <dqlite.h>\nvoid main(){dqlite_node_id n = 1;}" | $(CC) ${CGO_CFLAGS} -o /dev/null -xc - >/dev/null 2>&1 && echo "libsqlite3")
GOPATH ?= $(shell go env GOPATH)
CGO_LDFLAGS_ALLOW ?= (-Wl,-wrap,pthread_create)|(-Wl,-z,now)
SPHINXENV=.sphinx/venv/bin/activate
SPHINXENV=doc/.sphinx/venv/bin/activate

ifneq "$(wildcard vendor)" ""
RAFT_PATH=$(CURDIR)/vendor/raft
@@ -113,19 +113,20 @@ endif
.PHONY: doc
doc:
@echo "Setting up documentation build environment"
python3 -m venv .sphinx/venv
. $(SPHINXENV) ; pip install --upgrade -r .sphinx/requirements.txt
mkdir -p .sphinx/deps/ .sphinx/themes/
git -C .sphinx/deps/swagger-ui pull || git clone --depth 1 https://github.com/swagger-api/swagger-ui.git .sphinx/deps/swagger-ui
mkdir -p .sphinx/_static/swagger-ui
ln -sf ../../deps/swagger-ui/dist/swagger-ui-bundle.js ../../deps/swagger-ui/dist/swagger-ui-standalone-preset.js ../../deps/swagger-ui/dist/swagger-ui.css .sphinx/_static/swagger-ui/
python3 -m venv doc/.sphinx/venv
. $(SPHINXENV) ; pip install --upgrade -r doc/.sphinx/requirements.txt
mkdir -p doc/.sphinx/deps/ doc/.sphinx/themes/
git -C doc/.sphinx/deps/swagger-ui pull || git clone --depth 1 https://github.com/swagger-api/swagger-ui.git doc/.sphinx/deps/swagger-ui
mkdir -p doc/.sphinx/_static/swagger-ui
ln -sf ../../../deps/swagger-ui/dist/swagger-ui-bundle.js ../../../deps/swagger-ui/dist/swagger-ui-standalone-preset.js ../../../deps/swagger-ui/dist/swagger-ui.css doc/.sphinx/_static/swagger-ui/
wget -N -P doc/.sphinx/_static/download https://linuxcontainers.org/static/img/favicon.ico https://linuxcontainers.org/static/img/containers.png https://linuxcontainers.org/static/img/containers.small.png
rm -Rf doc/html
make doc-incremental

.PHONY: doc-incremental
doc-incremental:
@echo "Build the documentation"
. $(SPHINXENV) ; sphinx-build -c .sphinx/ -b dirhtml doc/ doc/html/ -w .sphinx/warnings.txt
. $(SPHINXENV) ; sphinx-build -c doc/ -b dirhtml doc/ doc/html/ -w doc/.sphinx/warnings.txt

.PHONY: doc-serve
doc-serve:
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
126 changes: 126 additions & 0 deletions doc/.sphinx/_static/version-switcher.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
/* JavaScript for the _templates/variant-selector.html file, implementing
* the version switcher for the documentation.
*
* The script gets available versions from the versions.json file on the
* master branch (because the master branch contains the current information
* on which versions we want to display).
* It then links to other versions of the documentation - to the same page
* if the page is available or to the index otherwise.
*/

// Link to the versions.json file on the master branch.
var versionURL = "https://linuxcontainers.org/lxd/docs/master/versions.json";

// URL prefix that is common for the different documentation sets.
var URLprefix = "https://linuxcontainers.org/lxd/docs/"



$(document).ready(function()
{

// Read the versions.json file and call the listVersions function.
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState === 4) {
if (xhr.status === 200) {
listVersions(JSON.parse(xhr.responseText));
}
else {
console.log("URL "+versionURL+" cannot be loaded.");
}
}
};
xhr.open('GET', versionURL, true);
xhr.send();

});

// Retrieve the name of the current documentation set (for example,
// 'master' or 'stable-5.0') and the path to the page (for example,
// 'howto/pagename/').
function getPaths()
{
var paths = {};

var prefix = new URL(URLprefix);
var url = window.location.pathname;

if (url.startsWith(prefix.pathname)) {

path = url.substr(prefix.pathname.length).split("/");
paths['current'] = path.shift();
if (paths['current'] == "master") {
paths['current'] = "latest";
};
paths['page'] = path.join("/");
}
else {
console.log("Unexpected hosting URL!");
}

return paths;

}

// Populate the version dropdown.
function listVersions(data)
{
paths = getPaths();

var all_versions = document.getElementById("all-versions");
var current = document.getElementById("current");
for( var i = 0; i < data.length; i++ )
{
var one = data[i];
if (one.id === paths['current']) {
// Put the current version at the top without link.
current.innerText = one.version+" ⌄";
}
else {
// Put other versions into the dropdown and link them to the
// suitable URL.
var version = document.createElement("a");
version.appendChild(document.createTextNode(one.version));
version.href = findNewURL(paths,one.id);
all_versions.appendChild(version);
}
}
}

// Check if the same page exists in the other documentation set.
// If yes, return the new link. Otherwise, link to the index page of
// the other documentation set.
function findNewURL(paths,newset) {

var newURL = URLprefix.concat(newset,"/",paths['page']);
var xhr = new XMLHttpRequest();
xhr.open('HEAD', newURL, false);
xhr.send();

if (xhr.status == "404") {
return URLprefix.concat(newset,"/");
} else {
return newURL;
}

}

// Toggle the version dropdown.
function dropdown() {
document.getElementById("all-versions").classList.toggle("show");
}

// Close the dropdown menu if the user clicks outside of it.
window.onclick = function(event) {
if (!event.target.matches('.version_select')) {
var dropdowns = document.getElementsByClassName("available_versions");
var i;
for (i = 0; i < dropdowns.length; i++) {
var openDropdown = dropdowns[i];
if (openDropdown.classList.contains('show')) {
openDropdown.classList.remove('show');
}
}
}
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions doc/.sphinx/_templates/sidebar/variant-selector.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div class="version_dropdown">
Doc version: <button onclick="dropdown()" class="version_select" id="current"></button>
<div id="all-versions" class="available_versions"></div>
</div>
File renamed without changes.
16 changes: 8 additions & 8 deletions .sphinx/conf.py → doc/conf.py
Original file line number Diff line number Diff line change
@@ -26,21 +26,21 @@
myst_linkify_fuzzy_links=False
myst_heading_anchors = 7

if os.path.exists("../doc/substitutions.yaml"):
with open("../doc/substitutions.yaml", "r") as fd:
if os.path.exists("./substitutions.yaml"):
with open("./substitutions.yaml", "r") as fd:
myst_substitutions = yaml.safe_load(fd.read())

# Setup theme.
templates_path = ["_templates"]
templates_path = [".sphinx/_templates"]

html_theme = "furo"
html_show_sphinx = False
html_last_updated_fmt = ""
html_favicon = "https://linuxcontainers.org/static/img/favicon.ico"
html_static_path = ['_static']
html_favicon = ".sphinx/_static/download/favicon.ico"
html_static_path = ['.sphinx/_static']
html_css_files = ['custom.css']
html_js_files = ['header-nav.js']
html_extra_path = ['_extra']
html_js_files = ['header-nav.js','version-switcher.js']
html_extra_path = ['.sphinx/_extra']

html_theme_options = {
"sidebar_hide_name": True,
@@ -109,7 +109,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['html', 'README.md']
exclude_patterns = ['html', 'README.md', '.sphinx']

# Setup redirects (https://documatt.gitlab.io/sphinx-reredirects/usage.html)
redirects = {
3 changes: 2 additions & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![LXD](../.sphinx/_static/download/containers.png)](https://linuxcontainers.org/lxd)

[![LXD](.sphinx/_static/download/containers.png)](https://linuxcontainers.org/lxd)

% Include content from [../README.md](../README.md)
```{include} ../README.md