gitlab-ci: Check coverage of GHC flags in users guide

This ensures that all GHC flags are documented during the documentation
build.

Fixes #17315.

1 files changed, 185 insertions, 0 deletions

diff --git a/docs/users_guide/expected-undocumented-flags.txt b/docs/users_guide/expected-undocumented-flags.txt
new file mode 100644
index 0000000000..041eeda3eb
--- /dev/null
+++ b/docs/users_guide/expected-undocumented-flags.txt
@@ -0,0 +1,185 @@
+-#include
+--abi-hash
+--backpack
+--print-booter-version
+--print-build-platform
+--print-c-compiler-flags
+--print-c-compiler-link-flags
+--print-debug-on
+--print-global-package-db
+--print-have-interpreter
+--print-have-native-code-generator
+--print-host-platform
+--print-ld-flags
+--print-leading-underscore
+--print-object-splitting-supported
+--print-project-git-commit-id
+--print-project-version
+--print-rts-ways
+--print-stage
+--print-support-smp
+--print-tables-next-to-code
+--print-target-platform
+--print-unregisterised
+--show-packages
+-Onot
+-Wall-missed-specializations
+-Walternative-layout-rule-transitional
+-Wauto-orphans
+-Wdefault
+-Wderiving-typeable
+-Wextra
+-Wimplicit-kind-vars
+-Wmissed-specializations
+-Wmissing-space-after-bang
+-Wnot
+-Wprepositive-qualified-module
+-XAlternativeLayoutRule
+-XAlternativeLayoutRuleTransitional
+-XAutoDeriveTypeable
+-XDoAndIfThenElse
+-XDoRec
+-XGHCForeignImportPrim
+-XGenerics
+-XHaskell2010
+-XHaskell98
+-XImplicitPrelude
+-XJavaScriptFFI
+-XMonoPatBinds
+-XMonomorphismRestriction
+-XParallelArrays
+-XPatternGuards
+-XPatternSignatures
+-XPolymorphicComponents
+-XRecordPuns
+-XRelaxedLayout
+-XRelaxedPolyRec
+-XTraditionalRecordSyntax
+-XUnliftedFFITypes
+-auto
+-auto-all
+-caf-all
+-copy-libs-when-linking
+-dannot-lint
+-dasm-lint
+-ddebug-output
+-ddump-asm-conflicts
+-ddump-call-arity
+-ddump-cs-trace
+-ddump-debug
+-ddump-exitify
+-ddump-simpl-trace
+-ddump-view-pattern-commoning
+-ddump-vt-trace
+-dppr-ticks
+-dsource-stats
+-dstg-stats
+-dsuppress-stg-exts
+-dynhisuf
+-dyno
+-dynosuf
+-exclude-module
+-fallow-incoherent-instances
+-fallow-overlapping-instances
+-fallow-undecidable-instances
+-farrows
+-fast-llvm
+-fbang-patterns
+-fbuilding-cabal-package
+-fconstraint-solver-iterations
+-fcontext-stack
+-fcross-module-specialize
+-fdiagnostics-color=always
+-fdiagnostics-color=auto
+-fdiagnostics-color=never
+-fembed-manifest
+-fextended-default-rules
+-fffi
+-ffi
+-fflat-cache
+-ffloat-all-lams
+-ffloat-lam-args
+-ffrontend-opt
+-fgen-manifest
+-fghci-history
+-fghci-sandbox
+-fhistory-size
+-fimplicit-params
+-fimplicit-prelude
+-firrefutable-tuples
+-fkeep-cafs
+-fkill-absence
+-fkill-one-shot
+-fmax-errors
+-fmax-pmcheck-iterations
+-fmono-pat-binds
+-fmonomorphism-restriction
+-fnum-constant-folding
+-fpre-inlining
+-fprof-count-entries
+-freduction-depth
+-frewrite-rules
+-fscoped-type-variables
+-fshared-implib
+-fshow-valid-hole-fits
+-fshow-valid-substitutions
+-fsort-valid-hole-fits
+-fspec-constr-recursive
+-fspecialize
+-fspecialize-aggressively
+-fstg-lift-lams-non-rec-args-any
+-fstg-lift-lams-rec-args-any
+-fth
+-ftype-function-depth
+-fuse-rpaths
+-fversion-macros
+-fvia-c
+-fworker-wrapper
+-haddock
+-haddock-opts
+-hpcdir
+-instantiated-with
+-keep-hi-file
+-keep-o-file
+-mavx
+-mavx2
+-mavx512cd
+-mavx512er
+-mavx512f
+-mavx512pf
+-mbmi
+-msse
+-msse3
+-msse4
+-n
+-no-auto
+-no-auto-all
+-no-caf-all
+-no-keep-hi-file
+-no-keep-hi-files
+-no-keep-o-file
+-no-keep-o-files
+-no-link
+-no-pie
+-no-recomp
+-no-rtsopts
+-no-user-package-conf
+-package-conf
+-package-name
+-pgmar
+-pgmranlib
+-recomp
+-relative-dynlib-paths
+-rtsopts=all
+-rtsopts=ignore
+-rtsopts=ignoreAll
+-rtsopts=none
+-rtsopts=some
+-smp
+-split-objs
+-syslib
+-this-component-id
+-this-package-key
+-ticky-LNE
+-ticky-allocd
+-ticky-dyn-thunk