1712 Commits

Author SHA1 Message Date
Julien Fischer
52317df5bb More fixes for the reference manual.
doc/mercury_reference_manual.texi:
    As above.
2026-04-11 00:29:44 +10:00
Julien Fischer
1dd97768b3 More fixes for the reference manual.
doc/mercury_reference_manual.texi:
    As above.
2026-04-11 00:21:56 +10:00
Julien Fischer
8fe54c3b8f Adjust markup.
doc/mercury_reference_manual.texi:
    As above.
2026-04-11 00:10:40 +10:00
Julien Fischer
3a97cc4496 Fix a copy-and-paste error.
doc/mercury_reference_manual.texi:
    Delete part of the Java data passing conventions that were accidently
    copied into those for C#.
2026-04-11 00:05:50 +10:00
Julien Fischer
641913d69b Fix more errors in the reference manual.
doc/mercury_reference_manual.texi:
     As above.
2026-04-11 00:00:45 +10:00
Julien Fischer
b47a0189e0 Fix errors in the reference manual.
doc/mercury_reference_manual.texi:
    Fix grammar in a number of spots.

    Fix errors in some examples.

    Fix the table mapping Mercury to CLI and C# types.
    There is no System.{Int8,UInt8} in the CLI; they should be
    System.SByte and System.Byte respectively.
2026-04-10 23:42:31 +10:00
Julien Fischer
048149773b Minor fixes for reference manual.
doc/mercury_reference_manual.texi:
    Fix inverted characters.

    Fix incorrect variable names in examples and the description
    of the DCG transformation.

    Fix an incorrect Java foreign_proc example.

    Fix the example of higher-order impure code; it would not
    compile as written.
2026-03-13 22:14:57 +11:00
Julien Fischer
f7f0efc555 Yet more user guide fixes.
doc/mercury_user_guide.texi:
    As above.
2026-02-18 20:58:27 +11:00
Julien Fischer
5249f31265 Yet more user guide fixes.
docs/mercury_user_texi:
    As above.
2026-02-18 20:46:27 +11:00
Julien Fischer
e7abff9cfa More user guide fixes.
docs/mercury_user_texi:
    As above.
2026-02-18 20:25:33 +11:00
Julien Fischer
4507b0cf16 Fix an option name in the user's guide.
docs/mercury_user_texi:
    s/--asm--labels/--asm-labels/
2026-02-18 20:21:20 +11:00
Julien Fischer
4fd875441b Fix issues in users guide.
docs/mercury_user_texi:
     As above.
2026-02-18 19:59:17 +11:00
Julien Fischer
d273f35d57 Fixes for reference manual.
doc/mercury_reference_manual.texi:
    Fix spelling, grammar and punctuation.

    Fix some incorrect examples.

    Fix inconsistent markup.
2026-02-18 14:23:15 +11:00
Julien Fischer
22139e728c Delete a very old FAQ entry.
doc/mercury_faq.texi:
    Delete an entry concerning GCC 2.6.3, which was released in
    1994.
2026-02-09 21:05:25 +11:00
Julien Fischer
84c46b83cd Fix some errors in the FAQ.
doc/mercury_faq.texi:
    As above.
2026-02-09 21:00:47 +11:00
Julien Fischer
53591838fe Fix some errors in the reference manual.
doc/mercury_reference_manual.texi:
    As above.
2026-02-09 15:39:35 +11:00
Julien Fischer
57469e6736 Fixes for reference manual.
doc/mercury_reference_manual.texi:
   Fix spelling and grammar.

   Expand "iff" to "if and only if".

   Use "choice point" consistently in the text instead of a mixture
   of that and "choicepoint".
2026-02-06 17:25:37 +11:00
Julien Fischer
fd6350931f More minor fixes for users guide.
docs/mercury_user_guide.texi:
    As above
2026-02-05 12:21:51 +11:00
Julien Fischer
8691e00b67 Minor fixes for users guide.
docs/mercury_user_guide.texi:
    As above
2026-02-05 11:42:54 +11:00
Julien Fischer
070d1fc661 Fix minor errors in the transition guide.
doc/mercury_transition_guide.texi:
    As above, these were identified by feeding the texinfo source
    for the manual into Gemini.
2026-01-20 19:57:37 +11:00
Julien Fischer
02625ad94b Fix minor errors in the reference manual.
doc/mercury_reference_manual.texi:
    As above, these were identified by feeding the texinfo source
    for the manual into Gemini.
2026-01-20 19:28:25 +11:00
Julien Fischer
ac642e9ef7 Update copyright notices for 2026.
LICENSE:
compiler/print_help.m:
doc/*.texi:
profiler/mercury_profile.m:
slice/mcov.m:
slice/mdice.m:
slice/mslice.m:
slice/mtc_diff.m:
slice/mtc_union.m:
trace/mercury_trace_Internal.c:
    As above.
2026-01-01 19:56:20 +11:00
Zoltan Somogyi
c4bb1a47b8 Fix indentation. 2025-12-14 18:54:28 +11:00
Julien Fischer
edc138122a Fix warnings from texinfo.
doc/mercury_user_guide.texi:
     Make the order of the menu in the "Grade Modifiers" section
     match the order of the sections in the text.
2025-09-23 12:56:11 +10:00
Zoltan Somogyi
83595c258c Update the description of module compilation.
doc/mercury_user_guide.texi:
    Fit the compilation section into its new position.

    Fix the description of C# compilation.

scripts/mgnuc.in:
    Change the help message NOT to assume that the C compiler is gcc,
    since we have supported other C compilers as well for a long time.

    Move a comment to the code it applies to.

compiler/mercury_compile_augment.m:
    Add a comment.

compiler/export.m:
    Replace /* */ C commments with // commments.
2025-08-31 15:24:56 +02:00
Zoltan Somogyi
47fd3440d9 Move a section to its chronological position. 2025-08-31 13:38:26 +02:00
Julien Fischer
dfa8d2411c Fix a texinfo error.
docs/mercury_user_guide.texi:
   Replace an invalid item marker.
2025-08-31 00:57:39 +10:00
Zoltan Somogyi
f0ad6bb5c6 Fix typos. 2025-08-30 12:47:51 +02:00
Zoltan Somogyi
b8d5ea9d6c Finish first draft of intermodule opt section. 2025-08-29 19:34:50 +02:00
Peter Wang
9f66809257 Fix texinfo syntax. 2025-08-20 10:50:33 +10:00
Zoltan Somogyi
089be6d2d8 Address review comments. 2025-08-19 19:50:37 +02:00
Zoltan Somogyi
7834e905c8 Address review comments. 2025-08-18 18:38:28 +02:00
Zoltan Somogyi
95f3c64561 s/main-module/main_module/ 2025-08-16 00:32:09 +02:00
Zoltan Somogyi
ec0d8ca957 Fill in a large part of "compilation detail".
Minor improvements to the preceding chapters.
2025-08-16 00:30:10 +02:00
Zoltan Somogyi
42d93dbe2f Document the .par grade modifier.
Make minor improvements elsewhere in the user guide.
2025-08-15 16:07:43 +02:00
Zoltan Somogyi
33e3a3bf7b Don't install pdfs by default. 2025-08-11 22:42:00 +02:00
Zoltan Somogyi
c7f7bdebe3 Update the library manual's introduction. 2025-08-11 08:01:26 +02:00
Zoltan Somogyi
79f1b9473d Fix typos. 2025-08-11 07:59:38 +02:00
Zoltan Somogyi
ae28a625cc Use consistent file-names in the doc directory.
Previously, we used to build e.g. mercury_ref.info from reference_manual.texi.
We now use these base files names consistently, with all relevant extensions:

    mercury_reference_manual
    mercury_user_guide
    mercury_library_manual
    mercury_transition_guide
    mercury_faq

doc/mercury_reference_manual.texi:
doc/mercury_user_guide.texi:
doc/mercury_library_manual.texi:
doc/mercury_transition_guide.texi:
doc/mercury_faq.texi:
    Rename the original .texi files to the new names.

    Rename any pointers between manuals.

doc/update_opts:
    Delete this unused file, since there is no point in updating it
    to use the new file names.

doc/Mmakefile:
    Rename files in variable definitions, target lists, source lists, actions,
    and comments.

    Replace blocks of file-name-specific rules with a single generic rule
    where the uniformity of names makes this possible.

    Start builtin pdf files by default, since the motivation for this change
    is fixing an inconsistency between .html and .pdf versions of the same
    manual.

    Change the naming scheme of intermediate files to fit into the new pattern.

    Delete the new_opts target, which we do not need anymore.

    Delete references to library_toc and library_1, which we stopped building
    in 2003.

doc/mercury.html.in:
doc/mercury.info.in:
    Conform to the renames.
2025-08-11 07:48:11 +02:00
Zoltan Somogyi
15e7bbebe3 Document .target_debug and .pregen. 2025-08-10 14:09:18 +02:00
Zoltan Somogyi
32006a1c7c Rename and generalize .c_debug to .target_debug.
runtime/mercury_grade.h:
    Rename the grade modifier, and the C macro that represents it.

compiler/options.m:
    Rename the --c-debug-grade option to --target-debug-grade.

compiler/compute_grade.m:
    Rename the grade modifier, and the option that represents it.

    Restrict the .target_debut grade modifier to MLDS grades.

compiler/handle_options.m:
    Implement --target-debug-grade by having it imply --target-debug.

compiler/compile_target_code.m:
compiler/link_target_code.m:
    Pay attention to either --target-debug-grade (for purposes related
    to the grade itself) and to --target-debug (for all other purposes).

scripts/canonical_grade.in:
scripts/canonical_grade.sh-subr:
scripts/final_grade_options.sh-subr:
scripts/init_grade_options.sh-subr:
scripts/parse_grade_options.sh-subr:
    Parse target_debug grade modifiers and --target-debug-grade options
    instead of c_debug grade modifiers and --c-debug-grade options.

    Add (normally commented-out) infrastructure to make it easier
    to debug changes.

    Restrict the .target_debut grade modifier to MLDS grades.

scripts/mgnuc.in:
scripts/mgnuc_file_opts.sh-subr:
    Rename some variables to clarify the distinction between the
    --target-debug option (which, like -g, enabled debugging of only one file)
    and the --target-debug-grade option (which enables it for the whole
    program).

configure.ac:
    Make it easier to debug grade-related changes by recording
    both autoconfigured and user-supplied grades that the rejected by
    the canonical_grade script.

    Conform to the changes above.

README.sanitizers:
doc/user_guide.texi:
grade_lib/grade_spec.m:
grade_lib/grade_string.m:
scripts/ml.in:
tests/warnings/help_text.err_exp:
tools/lmc.in:
tools/test_mercury:
    Conform to the changes above.

scripts/Mmake.vars.in:
    Add some XXXs about style.
2025-08-09 21:48:23 +02:00
Zoltan Somogyi
2489e2bd40 Avoid modeline comments in .pdf files. 2025-08-09 09:34:16 +02:00
Zoltan Somogyi
6586f6025a Address review comments.
Delete a long-obsolete XXX.
2025-08-08 10:48:41 +02:00
Zoltan Somogyi
966e464945 Fill in most of the Grade modifiers section. 2025-08-07 07:14:44 +02:00
Zoltan Somogyi
27829c6f87 Add a draft of most of the grades chapter. 2025-08-04 12:40:31 +02:00
Zoltan Somogyi
cabcea421d Address a review comment. 2025-08-03 15:08:06 +02:00
Zoltan Somogyi
f0d6530cec Fix typos. 2025-08-03 12:00:44 +02:00
Zoltan Somogyi
9eb506edc2 Move some existing chapters around. 2025-07-30 03:32:41 +02:00
Zoltan Somogyi
e2b472ec06 Start on the new structure of the user guide.
doc/user_guide.texi:
    Replace the "Using mmc" section, which tried to do too much,
    with an "Intro to mmc" section, which does a more thorough job
    of explaining some basics, but does not depend on concepts that
    are introduced only in later chapters.

    Start using @code and @command in the way we discussed on m-rev,
    though for now, only in the newly-written parts of the guide.

    Add chapter markers for the agreed-on chapters. Do not move
    existing text around as we also agreed; do that separately,
    to make reviewing this diff simpler.

    Document the new capability of mdb's dump command.

    Add a vim modeline.

    Replace tabs with spaces.

    Fix too-long lines where possible.
2025-07-27 12:30:08 +02:00
Zoltan Somogyi
cc5e0f5a55 Add vim mode lines, replace tabs with spaces. 2025-07-27 11:20:47 +02:00