build-doc: verify that there are no github readme links

baremetal/lib/syscalls_asm.S

@@ -15,7 +15,7 @@ _exit:
     LKMC_M5OPS_EXIT_ASM
 #else
 /* Use semihosting:
- * https://github.com/cirosantilli/linux-kernel-module-cheat#semihosting */
+ * https://cirosantilli.com/linux-kernel-module-cheat#semihosting */
 #if defined(__arm__)
     mov r0, #0x18
     ldr r1, =#0x20026

build-doc

@@ -56,6 +56,24 @@ from the README to example sources to GitHub rather than locally.
                     self.log_error('broken link to local file: ' + link)
                     exit_status = 1
 
+        # Check that there are not links to the GitHub README.
+        # https://github.com/isaacs/github/issues/1610
+        for grep_line in self.sh.check_output(
+            [
+                'git',
+                'grep',
+                '--fixed-strings',
+                self.env['github_repo_url'] + '#',
+                LF
+            ],
+            cwd=self.env['root_dir'],
+            raise_on_failure=False
+        ).decode().splitlines():
+            self.log_error('link to GitHub readme: {}'.format(
+                grep_line
+            ))
+            exit_status = 1
+
         # Check that non-README links to README IDs exit.
         header_ids = set()
         grep_line_location_re = re.compile('^(.*?:\d+):')

common.py

@@ -102,6 +102,7 @@ consts['sha'] = common.git_sha(consts['root_dir'])
 consts['release_dir'] = os.path.join(consts['out_dir'], 'release')
 consts['release_zip_file'] = os.path.join(consts['release_dir'], 'lkmc-{}.zip'.format(consts['sha']))
 consts['github_repo_id'] = 'cirosantilli/linux-kernel-module-cheat'
+consts['github_repo_url'] = 'https://github.com/' + consts['github_repo_id']
 consts['homepage_url'] = 'https://cirosantilli.com/linux-kernel-module-cheat'
 consts['asm_ext'] = '.S'
 consts['c_ext'] = '.c'

path_properties.py

@@ -260,7 +260,7 @@ gnu_extension_properties = {
     'cc_pedantic': False,
     'cxx_std': 'gnu++17'
 }
-# https://github.com/cirosantilli/linux-kernel-module-cheat#freestanding-programs
+# https://cirosantilli.com/linux-kernel-module-cheat#freestanding-programs
 freestanding_properties = {
     'baremetal': False,
     'cc_flags': [
@@ -270,7 +270,7 @@ freestanding_properties = {
     ],
     'extra_objs_lkmc_common': False,
 }
-# https://github.com/cirosantilli/linux-kernel-module-cheat#nostartfiles-programs
+# https://cirosantilli.com/linux-kernel-module-cheat#nostartfiles-programs
 nostartfiles_properties = {
     'baremetal': False,
     'cc_flags': [

userland/arch/aarch64/freestanding/README.adoc

@@ -1 +1 @@
-https://github.com/cirosantilli/linux-kernel-module-cheat#freestanding-programs
+https://cirosantilli.com/linux-kernel-module-cheat#freestanding-programs

userland/arch/aarch64/nostartfiles/README.adoc

@@ -1 +1 @@
-https://github.com/cirosantilli/linux-kernel-module-cheat#nostartfiles-programs
+https://cirosantilli.com/linux-kernel-module-cheat#nostartfiles-programs

userland/arch/arm/freestanding/README.adoc

@@ -1 +1 @@
-https://github.com/cirosantilli/linux-kernel-module-cheat#freestanding-programs
+https://cirosantilli.com/linux-kernel-module-cheat#freestanding-programs

userland/arch/x86_64/freestanding/README.adoc

@@ -1 +1 @@
-https://github.com/cirosantilli/linux-kernel-module-cheat#freestanding-programs
+https://cirosantilli.com/linux-kernel-module-cheat#freestanding-programs