move sidebars to always be before a section header or end of doc

Author: StefanKarpinski

doc/devdocs/eval.rst

@@ -12,11 +12,6 @@ Each chunk of code typically makes a trip through many esoteric acronyms such as
 `compile`, `parse`, `execute`, `JIT`, `interpret`, `box`, `unbox`, `intrinsic function`, `primitive function`
 before turning into the desired result (hopefully).
 
-Julia Execution
----------------
-
-The 10,000 foot view of the whole process is as follows:
-
 .. sidebar:: Definitions
 
    REPL
@@ -29,6 +24,12 @@ The 10,000 foot view of the whole process is as follows:
      In this form the code has been tokenized for meaning
      so that it is more suitable for manipulation and execution.
 
+
+Julia Execution
+---------------
+
+The 10,000 foot view of the whole process is as follows:
+
 1. The user starts `julia`.
 2. The C function :c:func:`main` from `ui/repl.c` gets called.
    This function processes the command line arguments, filling in the :c:type:`jl_options` struct and setting the variable :code:`ARGS`.
@@ -97,11 +98,6 @@ This enables many future optimizations, such as unboxing of known immutable valu
 and compile-time hoisting of various run-time operations such as computing field offsets and function pointers.
 Type inference may also include other steps such as constant propagation and inlining.
 
-.. _codegen:
-
-JIT Code Generation
--------------------
-
 .. sidebar:: More Definitions
 
     JIT
@@ -145,6 +141,11 @@ JIT Code Generation
       Since they operate on bits directly, they must be compiled into a function
       and surrounded by a call to `Core.Intrinsics.box(T, ...)` to reassign type information to the value.
 
+.. _codegen:
+
+JIT Code Generation
+-------------------
+
 Codegen is the process of turning a Julia AST into native machine code.
 
 The JIT environment is initialized by an early call to `jl_init_codegen in codegen.cpp <https://github.com/JuliaLang/julia/blob/master/src/codegen.cpp>`_.
@@ -168,11 +169,6 @@ Other parts of codegen are handled by various helper files:
 `intrinsics.cpp <https://github.com/JuliaLang/julia/blob/master/src/intrinsics.cpp>`_
   Handles the emission of various low-level intrinsic functions
 
-.. _sysimg:
-
-System Image
-------------
-
 .. sidebar:: Bootstrapping
 
     The process of creating a new system image is called "bootstrapping".
@@ -181,6 +177,11 @@ System Image
     and refers to the idea of starting from a very limited set of available functions and definitions
     and ending with the creation of a full-featured environment.
 
+.. _sysimg:
+
+System Image
+------------
+
 The system image is a precompiled archive of a set of Julia files.
 The `sys.ji` file distributed with Julia is one such system image,
 generated by executing the file `sysimg.jl <https://github.com/JuliaLang/julia/blob/master/base/sysimg.jl>`_,

doc/devdocs/init.rst

@@ -92,15 +92,6 @@ initialises 8-bit serialisation tags for 256 frequently used
 ``jl_value_t`` values. The serialisation mechanism uses these tags as
 shorthand (in lieu of storing whole objects) to save storage space.
 
-.. sidebar:: sysimg
-
-    If there is a sysimg file, it contains a pre-cooked image of the :mod:`Core` and :mod:`Main` modules (and whatever else is created by ``boot.jl``). See :ref:`dev-sysimg`.
-
-    `jl_restore_system_image() <https://github.com/JuliaLang/julia/blob/master/src/dump.c>`_ de-serialises the saved sysimg into the current Julia runtime environment and initialisation continues after :c:func:`jl_init_box_caches` below...
-
-    Note: `jl_restore_system_image() (and dump.c in general) <https://github.com/JuliaLang/julia/blob/master/src/dump.c>`_ uses the :ref:`dev-ios`.
-
-
 If there is no sysimg file (:code:`!jl_options.image_file`) then
 then :mod:`Core` and :mod:`Main` modules are created and ``boot.jl`` is evaluated:
 
@@ -164,6 +155,14 @@ Finally `sigint_handler() <https://github.com/JuliaLang/julia/blob/master/src/si
 :c:func:`_julia_init` then returns `back to main() in julia/ui/repl.c
 <https://github.com/JuliaLang/julia/blob/master/ui/repl.c>`_ and main() calls :code:`true_main(argc, (char**)argv)`.
 
+.. sidebar:: sysimg
+
+    If there is a sysimg file, it contains a pre-cooked image of the :mod:`Core` and :mod:`Main` modules (and whatever else is created by ``boot.jl``). See :ref:`dev-sysimg`.
+
+    `jl_restore_system_image() <https://github.com/JuliaLang/julia/blob/master/src/dump.c>`_ de-serialises the saved sysimg into the current Julia runtime environment and initialisation continues after :c:func:`jl_init_box_caches` below...
+
+    Note: `jl_restore_system_image() (and dump.c in general) <https://github.com/JuliaLang/julia/blob/master/src/dump.c>`_ uses the :ref:`dev-ios`.
+
 true_main()
 -----------
 

doc/devdocs/object.rst

@@ -166,6 +166,9 @@ then tagged with its type::
     jl_value_t *jl_gc_allocobj(size_t nbytes);
     void jl_set_typeof(jl_value_t *v, jl_datatype_t *type);
 
+Note that all objects are allocated in multiples of 4 bytes and aligned to the platform pointer size.
+Memory is allocated from a pool for smaller objects, or directly with :c:func:`malloc` for large objects.
+
 .. sidebar:: :ref:`man-singleton-types`
 
     Singleton types have only one instance and no data fields.
@@ -174,6 +177,3 @@ then tagged with its type::
     e.g. :data:`nothing::Void`.
 
     See :ref:`man-singleton-types` and :ref:`man-nothing`
-
-Note that all objects are allocated in multiples of 4 bytes and aligned to the platform pointer size.
-Memory is allocated from a pool for smaller objects, or directly with :c:func:`malloc` for large objects.