Skip to content

Add search indices for compiler flags #27452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 1, 2025

Conversation

benharsh
Copy link
Member

@benharsh benharsh commented Jun 26, 2025

This PR adds index directives to each compiler flag in the man page so that we can search for them.

Generated with copilot.

Resolves #27340

Testing:

  • make docs
  • spot-checked flags at random for searchability

benharsh added 2 commits June 26, 2025 16:19
Generated with copilot

Signed-off-by: Ben Harshbarger <ben.harshb@gmail.com>
Generated with copilot

Signed-off-by: Ben Harshbarger <ben.harshb@gmail.com>
@benharsh benharsh marked this pull request as draft June 27, 2025 00:24
Signed-off-by: Ben Harshbarger <ben.harshb@gmail.com>
@benharsh benharsh marked this pull request as ready for review June 27, 2025 22:14
Copy link
Member

@jabraham17 jabraham17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Its really nice to be able to search flags.

I also commented on all of the single letter flags, which aren't included. Was that intentional or an oversight.

@@ -630,6 +699,7 @@ OPTIONS
compiler.

.. _man-debug:
.. index:: --debug, --no-debug
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -g


**\--copyright**

Print the compiler's copyright information.

.. _man-help:
.. index:: --help
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -h

@@ -648,6 +719,7 @@ OPTIONS
default.

.. _man-hdr-search-path:
.. index:: --hdr-search-path
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -I

@@ -667,13 +740,15 @@ OPTIONS
forwarded to the C compiler.

.. _man-lib-linkage:
.. index:: --lib-linkage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -l


**-l, \--lib-linkage <library>**

Specify a C library to link to on the back-end C compiler command
line.

.. _man-lib-search-path:
.. index:: --lib-search-path
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -L

@@ -74,6 +76,7 @@ OPTIONS
point for program execution.

.. _man-module-dir:
.. index:: --module-dir
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -M

@@ -684,6 +759,7 @@ OPTIONS
directories.

.. _man-optimize:
.. index:: --optimize, --no-optimize
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -O


**\--[no-]print-unused-functions**

Print the names and source locations of unused functions within the
user program.

.. _man-set:
.. index:: --set
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also have -s

Signed-off-by: Ben Harshbarger <ben.harshb@gmail.com>
@benharsh benharsh merged commit 398327e into chapel-lang:main Jul 1, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: Chapel flags don't show up in the web search
2 participants