Skip to content
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

Added info for getting compilation output from meson on autorebuild #27053

Merged
merged 1 commit into from
Oct 20, 2023

Conversation

story645
Copy link
Member

PR summary

Added a short sentence/command for building with compilation logs enabled cause I figure it's gonna be a commonish need of anyone working with the c-extension files.

PR checklist

@story645 story645 added the Documentation: devdocs files in doc/devel label Oct 10, 2023
@story645 story645 force-pushed the meson-verbose branch 4 times, most recently from b258617 to 87faf31 Compare October 11, 2023 03:16
@ksunden
Copy link
Member

ksunden commented Oct 11, 2023

Personally, I think the env-var makes a lot more sense for the "I occasionally want to see the logs" pattern rather than setting it on install.

I'm also slightly weary of the "relatively recently" language here, as I don't particularly like putting time-sensitive verbiage in these docs (at least not in the past tense, less worried about things that "will change" and thus the docs need to be updated once it "has changed"), preferring the phrasing which does not make us have to either a) make a judgement call of when it should be removed before it is just untrue to call it "recent" or b) leave it untouched long enough for it to be unequivocally false. The phrasing of "before this commit" will remain true even if there is still a time where it is functionally irrelevant.

@story645
Copy link
Member Author

Personally, I think the env-var makes a lot more sense for the "I occasionally want to see the logs" pattern rather than setting it on install.

I really hate dealing with environment variables and am frequently going through a whole bunch of shells when working on anything. If I'm working with C++ files then I want the compilation logs in a way where I don't have to remember to set environment variables every time I open a new shell.

@story645 story645 force-pushed the meson-verbose branch 4 times, most recently from 790a2de to 07a86c8 Compare October 11, 2023 05:59
@story645
Copy link
Member Author

Edited to include the envar, remove recently, and make more explicit what folks should look for to figure out if their branch is meson enabled.

@story645 story645 force-pushed the meson-verbose branch 4 times, most recently from 41d9849 to 5ae036f Compare October 12, 2023 15:08
re-run the above command.
This allows you to import your modified version of Matplotlib without having to
re-install after changing a ``.py`` or compiled extension file. On Windows, you
may need to :external+meson-python:ref:`vsenv-example`.
Copy link
Member

Choose a reason for hiding this comment

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

Why is this generating warnings?

Copy link
Member Author

Choose a reason for hiding this comment

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

old headers - @QuLogic flagged this in #26992 (comment)

I'm adding this line b/c the default git install on windows requires MSYS2 but all our dependency instructions are for MSVC, so I figure I'm not gonna be the only one who will run into this issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

granted, I'll also go update the dependency instructions since I've got #27058 anyway

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure if that's a usual thing right now. On my current-version Git-for-Windows, Git Bash is in MSYS2, but there are no compilers installed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Is there any harm in mentioning this as an option? This is 100% a thing I didn't think to think of until you mentioned it, & it's a sentence here.

Copy link
Member

Choose a reason for hiding this comment

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

The move to troubleshooting seems good.

@story645 story645 marked this pull request as draft October 17, 2023 21:06
@story645 story645 marked this pull request as ready for review October 17, 2023 21:46
@story645
Copy link
Member Author

Reworked this so:

  1. editable config info is in a standalone subsection
  2. msvc info is in troubleshooting

@story645 story645 added this to the v3.9.0 milestone Oct 18, 2023
doc/devel/troubleshooting.rst Outdated Show resolved Hide resolved
re-run the above command.
This allows you to import your modified version of Matplotlib without having to
re-install after changing a ``.py`` or compiled extension file. On Windows, you
may need to :external+meson-python:ref:`vsenv-example`.
Copy link
Member

Choose a reason for hiding this comment

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

The move to troubleshooting seems good.

added force MSVC to troubleshooting
added meson-python to intersphinx

Co-authored-by: Kyle Sunden <git@ksunden.space>
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@QuLogic QuLogic merged commit ddf9163 into matplotlib:main Oct 20, 2023
40 checks passed
@story645 story645 deleted the meson-verbose branch October 20, 2023 04:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants