anil.recoil.org / unpac-unpac
The unpac monorepo manager self-hosting as a monorepo using unpac
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

AsciiDoc: use xrefs to other adoc files, more links

Antonin Décimo f9d60f7c 784963a3

+53 -53
+46 -46
HACKING.adoc
··· 24 24 not have this which causes some important development things to be disabled 25 25 (ocamltest and converting C compiler warnings to errors). 26 26 27 - 2. Consult link:INSTALL.adoc[] for build instructions. Here is the gist of it: 27 + 2. Consult xref:INSTALL.adoc[] for build instructions. Here is the gist of it: 28 28 + 29 29 [source,sh] 30 30 ---- ··· 113 113 114 114 Parses source files and produces an Abstract Syntax Tree (AST) 115 115 (link:parsing/parsetree.mli[] has lot of helpful comments). See 116 - link:parsing/HACKING.adoc[]. 116 + xref:parsing/HACKING.adoc[]. 117 117 118 118 The logic for Camlp4 and Ppx preprocessing is not in link:parsing/[], 119 119 but in link:driver/[], see link:driver/pparse.mli[] and ··· 123 123 124 124 Type-checks the AST and produces a typed representation of the program 125 125 (link:typing/typedtree.mli[] has some helpful comments). See 126 - link:typing/HACKING.adoc[]. 126 + xref:typing/HACKING.adoc[]. 127 127 128 128 ==== The bytecode compiler -- link:bytecomp/[] 129 129 ··· 145 145 and `runtime_NATIVE_ONLY_C_SOURCES` in link:Makefile[] for the list of common, 146 146 bytecode-only, and native-only source files.) 147 147 148 - See link:runtime/HACKING.adoc[]. 148 + See xref:runtime/HACKING.adoc[]. 149 149 150 150 === Libraries 151 151 ··· 183 183 184 184 === Complete file listing 185 185 186 - BOOTSTRAP.adoc:: instructions for bootstrapping 187 - Changes:: what's new with each release 188 - CONTRIBUTING.md:: how to contribute to OCaml 189 - HACKING.adoc:: this file 190 - INSTALL.adoc:: instructions for installation 191 - LICENSE:: license and copyright notice 192 - Makefile:: main Makefile 193 - Makefile.common:: common Makefile definitions 194 - README.adoc:: general information on the compiler distribution 195 - README.win32.adoc:: general information on the Windows ports of OCaml 196 - VERSION:: version string. Run `tools/autogen` after changing. 197 - asmcomp/:: native-code compiler and linker 198 - boot/:: bootstrap compiler 199 - build-aux/:: autotools support scripts 200 - bytecomp/:: bytecode compiler and linker 201 - compilerlibs/:: the OCaml compiler as a library 202 - configure:: configure script 203 - configure.ac:: autoconf input file 204 - debugger/:: source-level replay debugger 205 - driver/:: driver code for the compilers 206 - flexdll/:: git submodule -- see link:README.win32.adoc[] 207 - lex/:: lexer generator 208 - man/:: man pages 209 - manual/:: system to generate the manual 210 - middle_end/:: the flambda optimisation phase 211 - ocamldoc/:: documentation generator 212 - ocamltest/:: test driver 213 - otherlibs/:: several additional libraries 214 - parsing/:: syntax analysis -- see link:parsing/HACKING.adoc[] 215 - release-info/:: documentation and tools to prepare releases 216 - runtime/:: bytecode interpreter and runtime systems 217 - stdlib/:: standard library 218 - testsuite/:: tests -- see link:testsuite/HACKING.adoc[] 219 - tools/:: various utilities 220 - toplevel/:: interactive system 221 - typing/:: typechecking -- see link:typing/HACKING.adoc[] 222 - utils/:: utility libraries 223 - winpthreads/:: winpthreads submodule -- see <<winpthreads,further>> 224 - yacc/:: parser generator 186 + xref:BOOTSTRAP.adoc[]:: instructions for bootstrapping 187 + link:Changes[]:: what’s new with each release 188 + link:CONTRIBUTING.md[]:: how to contribute to OCaml 189 + xref:HACKING.adoc[]:: this file 190 + xref:INSTALL.adoc[]:: instructions for installation 191 + link:LICENSE[]:: license and copyright notice 192 + link:Makefile[]:: main Makefile 193 + link:Makefile.common[]:: common Makefile definitions 194 + xref:README.adoc[]:: general information on the compiler distribution 195 + xref:README.win32.adoc[]:: general information on the Windows ports of OCaml 196 + link:VERSION[]:: version string. Run `make configure` after changing. 197 + link:asmcomp/[]:: native-code compiler and linker 198 + link:boot/[]:: bootstrap compiler 199 + link:build-aux/[]:: autotools support scripts 200 + link:bytecomp/[]:: bytecode compiler and linker 201 + link:compilerlibs/[]:: the OCaml compiler as a library 202 + link:configure[]:: configure script 203 + link:configure.ac[]:: autoconf input file 204 + link:debugger/[]:: source-level replay debugger 205 + link:driver/[]:: driver code for the compilers 206 + link:flexdll/[]:: git submodule -- see xref:README.win32.adoc[] 207 + link:lex/[]:: lexer generator 208 + link:man/[]:: man pages 209 + link:manual/[]:: system to generate the manual 210 + link:middle_end/[]:: the flambda optimisation phase 211 + link:ocamldoc/[]:: documentation generator 212 + link:ocamltest/[]:: test driver 213 + link:otherlibs/[]:: several additional libraries 214 + link:parsing/[]:: syntax analysis -- see xref:parsing/HACKING.adoc[] 215 + link:release-info/[]:: documentation and tools to prepare releases 216 + link:runtime/[]:: bytecode interpreter and runtime systems 217 + link:stdlib/[]:: standard library 218 + link:testsuite/[]:: tests -- see xref:testsuite/HACKING.adoc[] 219 + link:tools/[]:: various utilities 220 + link:toplevel/[]:: interactive system 221 + link:typing/[]:: typechecking -- see xref:typing/HACKING.adoc[] 222 + link:utils/[]:: utility libraries 223 + link:winpthreads/[]:: winpthreads submodule -- see <<winpthreads,further>> 224 + link:yacc/[]:: parser generator 225 225 226 226 [#tips] 227 227 == Development tips and tricks ··· 418 418 419 419 === Useful Makefile targets and options 420 420 421 - Besides the targets listed in link:INSTALL.adoc[] for build and 421 + Besides the targets listed in xref:INSTALL.adoc[] for build and 422 422 installation, the following targets may be of use: 423 423 424 424 `make runtop` :: builds and runs the ocaml toplevel of the distribution ··· 431 431 432 432 `make depend`:: Regenerate the `.depend` file. Should be used each time new dependencies are added between files. 433 433 434 - `make -C testsuite parallel`:: see link:testsuite/HACKING.adoc[] 434 + `make -C testsuite parallel`:: see xref:testsuite/HACKING.adoc[] 435 435 436 436 You can use `make foo V=1` to build the target foo and show full 437 437 commands instead of abbreviated names like OCAMLC, etc. This can be ··· 482 482 link:boot/[] directory. These bytecode images are used once the 483 483 bytecode runtime (which is written in C) has been built to compile the 484 484 standard library and then to build a fresh compiler. Details can be 485 - found in link:BOOTSTRAP.adoc[]. 485 + found in xref:BOOTSTRAP.adoc[]. 486 486 487 487 === Speeding up builds 488 488
+1 -1
INSTALL.adoc
··· 25 25 ** For Windows + 26 26 To produce native Windows executables from OCaml sources, you need to use 27 27 the MSVC or MinGW-w64 ports of OCaml, described in file 28 - https://github.com/ocaml/ocaml/blob/trunk/README.win32.adoc[README.win32.adoc]. + 28 + xref:README.win32.adoc[]. + 29 29 For a more Unix-like experience, you can use WSL, the 30 30 https://aka.ms/wsl[Windows Subsystem for Linux], or the 31 31 https://www.cygwin.com/[Cygwin environment]. You will need the
+3 -3
README.adoc
··· 86 86 87 87 == Installation 88 88 89 - See the file link:INSTALL.adoc[] for installation instructions on 89 + See the file xref:INSTALL.adoc[] for installation instructions on 90 90 machines running Unix, Linux, macOS, WSL and Cygwin. For native Microsoft 91 - Windows, see link:README.win32.adoc[]. 91 + Windows, see xref:README.win32.adoc[]. 92 92 93 93 == Documentation 94 94 ··· 146 146 147 147 == Contributing 148 148 149 - For information on contributing to OCaml, see link:HACKING.adoc[] and 149 + For information on contributing to OCaml, see xref:HACKING.adoc[] and 150 150 link:CONTRIBUTING.md[]. 151 151 152 152 == Separately maintained components
+1 -1
README.win32.adoc
··· 43 43 44 44 Cygwin aims to provide a Unix-like environment on Windows, and the build 45 45 procedure for it is the same as for other flavours of Unix. See 46 - link:INSTALL.adoc[] for full instructions. 46 + xref:INSTALL.adoc[] for full instructions. 47 47 48 48 OCaml requires Windows 8 or later and naturally the 64-bit versions need a 49 49 64-bit edition of Windows (note that this is both to run *and* build).
+1 -1
stdlib/HACKING.adoc
··· 6 6 Note: All paths are given relative to the root of the repository. 7 7 8 8 First, build the compiler. Run `./configure`, then `make`. See 9 - link:../HACKING.adoc[]. 9 + xref:../HACKING.adoc[]. 10 10 11 11 To add a new module, you must: 12 12
+1 -1
utils/HACKING.adoc
··· 19 19 increment the version of every kind of magic number. 20 20 21 21 The process for bootstrapping the compiler is covered in 22 - link:../BOOTSTRAP.adoc[BOOTSTRAP.adoc]. There is also a test script in CI which 22 + xref:../BOOTSTRAP.adoc[]. There is also a test script in CI which 23 23 demonstrates the process in 24 24 link:../tools/ci/inria/bootstrap/script[tools/ci/inria/bootstrap]. 25 25