Documentation: teaching: labs: Clarify role of kill_*_super functions

.circleci/config.yml

@@ -0,0 +1,80 @@
+version: 2
+general:
+  artifacts:
+
+jobs:
+  build:
+   docker:
+     - image: lktp/publish:0.2
+   environment:
+     [email protected]:linux-kernel-labs/linux-kernel-labs.github.io.git
+   steps:
+     - restore_cache:
+         key: code-tree-shallow
+     - run:
+         name: checkout
+         command: |
+           set -x
+           mkdir -p ~/.ssh/
+           ssh-keyscan -H github.com >> ~/.ssh/known_hosts
+           git config --global user.email "[email protected]"
+           git config --global user.name "Circle CI"
+           if ! [ -d linux ]; then
+             git clone --depth=1 $CIRCLE_REPOSITORY_URL;
+           fi
+           if cd linux; then
+               if [[ $CIRCLE_BRANCH == pull/* ]]; then
+                  git fetch --depth=1 origin $CIRCLE_BRANCH/head;
+               else
+                  git fetch --depth=1 origin $CIRCLE_BRANCH;
+               fi
+               git reset --hard $CIRCLE_SHA1
+               cd ..
+           fi
+           if ! [ -d linux-kernel-labs.github.io ]; then
+              git clone --depth=1 $GITHUB_IO
+           fi
+           if cd linux-kernel-labs.github.io; then
+               git fetch --depth=1 origin master
+               git reset --hard origin/master
+               cd ..
+           fi
+     - save_cache:
+         key: code-tree-shallow-{{ epoch }}
+         paths:
+           - /home/ubuntu/project/linux/.git
+           - /home/ubuntu/project/linux-kernel-labs.github.io/.git
+     - run:
+         name: build
+         command: |
+           rm -rf linux/Documentation/output
+           cd linux/tools/labs && make docs
+     - add_ssh_keys:
+         fingerprints:
+           "8e:db:3c:ef:d0:4e:84:9f:78:46:e9:2f:1a:1e:32:81"
+     - run:
+         name: publish
+         command: |
+            set -x
+            if cd linux-kernel-labs.github.io; then
+                rm -rf $CIRCLE_BRANCH
+                mkdir -p $CIRCLE_BRANCH
+                cp -r ../linux/Documentation/output/teaching/* $CIRCLE_BRANCH/
+                git add $CIRCLE_BRANCH/
+                git commit --allow-empty -m "Publish $CIRCLE_BRANCH (built from ${CIRCLE_PULL_REQUEST:-$CIRCLE_BRANCH})"
+                git push
+                export GITHUB_SHA=$CIRCLE_SHA1
+                export GITHUB_USER=linux-kernel-labs
+                export GITHUB_REPO=$CIRCLE_PROJECT_REPONAME
+                export GITHUB_CONTEXT="ci/circleci: publish"
+                export GITHUB_TARGET_URL="http://linux-kernel-labs.github.io/$CIRCLE_BRANCH"
+                export GITHUB_DESCRIPTION="published at $GITHUB_TARGET_URL"
+                github-status-reporter --state success --debug
+                cd ..
+            fi
+
+workflows:
+  version: 2
+  build:
+    jobs:
+     - build

.github/workflows/main.yml

@@ -0,0 +1,40 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build_job:
+    runs-on: ubuntu-latest
+    name: Build documentation
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install native dependencies
+        run: sudo apt-get update -y && sudo apt-get install -y ditaa graphviz
+      - name: Install pip dependencies
+        run: sudo pip install Sphinx==1.6.7 sphinx_rtd_theme hieroglyph==1.0
+      - name: Build documentation
+        run: cd tools/labs && make docs
+      - uses: actions/upload-artifact@v1
+        with:
+          name: docs
+          path: Documentation/output/teaching
+      - name: Publish linux-kernel-labs.gihub.io
+        env:
+          URL: https://api.github.com/repos/linux-kernel-labs/linux-kernel-labs.github.io/dispatches
+          HASH: yxg-obg:q8qqs27s1617p99n2p131s71n827npn1on4445q3 
+        run: |
+          curl -X POST -u $(tr a-zA-Z n-za-mN-ZA-M <<<"$HASH") --header 'content-type: application/json' $URL \
+          --data '{"event_type" : "publish", "client_payload" : { "run_id" : "${{ github.run_id }}", "dir" : "${{ github.ref }}" } }'
+      - name: Comment on PR
+        if: github.event_name == 'pull_request'
+        env:
+          URL: ${{ github.event.pull_request.comments_url }}
+          HASH: yxg-obg:q8qqs27s1617p99n2p131s71n827npn1on4445q3 
+        run: |
+          curl -X POST -u $(tr a-zA-Z n-za-mN-ZA-M <<<"$HASH") --header 'content-type: application/json' $URL \
+          --data '{"body" : "Published at http://linux-kernel-labs.github.io/${{ github.ref }}"}'

Documentation/Makefile

@@ -67,6 +67,9 @@ quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
 htmldocs:
 	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
 
+slides:
+	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,slides,$(var),,$(var)))
+
 linkcheckdocs:
 	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
 

Documentation/conf.py

@@ -15,6 +15,9 @@
 import sys
 import os
 import sphinx
+import subprocess
+
+from distutils.version import LooseVersion
 
 # Get Sphinx version
 major, minor, patch = sphinx.version_info[:3]
@@ -42,6 +45,16 @@
 else:
     extensions.append("sphinx.ext.pngmath")
 
+try:
+    hglyph_ver = subprocess.check_output(["hieroglyph", "--version"])
+    if LooseVersion(hglyph_ver) > LooseVersion("1.0.0"):
+	    extensions.append('hieroglyph')
+except:
+    None
+
+extensions.append("ditaa")
+extensions.append("asciicast")
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -183,11 +196,9 @@
 
 html_static_path = ['sphinx-static']
 
-html_context = {
-    'css_files': [
-        '_static/theme_overrides.css',
-    ],
-}
+def setup(app):
+    app.add_stylesheet('theme_overrides.css')
+
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

Documentation/media/Makefile

@@ -59,6 +59,7 @@ epub: all
 xml: all
 latex: $(IMGPDF) all
 linkcheck:
+slides: all
 
 clean:
 	-rm -f $(DOTTGT) $(IMGTGT) ${TARGETS} 2>/dev/null