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

doxygen -x_noenv option to not expand environment variables #9187

Closed
Tracked by #748
ferdymercury opened this issue Mar 6, 2022 · 5 comments
Closed
Tracked by #748

doxygen -x_noenv option to not expand environment variables #9187

ferdymercury opened this issue Mar 6, 2022 · 5 comments
Labels
enhancement a request to enhance doxygen, not a bug

Comments

@ferdymercury
Copy link
Contributor

Describe the bug
doxygen -x expands environment variables before doing the 'diff'.

Expected behavior
It would be interesting to have a "-x2" option that does not substitute the environment variables but rather treats them as plain text so that the 'real diff' is shown.

Screenshots
Let's assume an external user is inspecting a 'foreign Doxyfile' and does not have info about whether there are environmental variables defined within (thus, they are undefined in the shell). He gets:

doxygen -x Doxyfile
# Difference with default Doxyfile 1.9.4 (70d1c6baf5107dcfaae6fee02ea6b3ef93cea61c*)

So it's empty, no differences. Versus the manual diff I do normally:

diff Doxyfile Doxyfile.orig
41c41
< PROJECT_NUMBER         = $(SOME_VARIABLE)
---
> PROJECT_NUMBER         =

which shows the difference.

To Reproduce

  • doxygen -g
  • cp Doxyfile Doxyfile.orig
  • Open the generated file and set PROJECT_NUMBER = $(SOME_VARIABLE)
  • doxygen -x Doxyfile
  • diff Doxyfile Doxyfile.orig

Version
Doxyfile 1.9.4 (70d1c6b*)

@ferdymercury ferdymercury changed the title doxygen -x do not expand environment variables doxygen -x2 option to not expand environment variables Mar 6, 2022
@albert-github albert-github added the enhancement a request to enhance doxygen, not a bug label Mar 6, 2022
@albert-github
Copy link
Collaborator

The idea behind doxygen -x is that it gives the differences between the Doxyfile that will be used when running doxygen and the default doxygen settings.
The mentioned idea / use case of having the possibility to retain the original environment settings is not a bad idea, though -x2 probably would be better as -x_noenv.

@ferdymercury ferdymercury changed the title doxygen -x2 option to not expand environment variables doxygen -x_noenv option to not expand environment variables Mar 6, 2022
albert-github added a commit to albert-github/doxygen that referenced this issue Mar 7, 2022
…variables

Adding the possibility to retain the environment variables (`$(...)`) in the doxyfile when looking for differences with the default settings.
albert-github added a commit to albert-github/doxygen that referenced this issue Mar 7, 2022
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #9189

doxygen added a commit that referenced this issue Mar 9, 2022
issue #9187 doxygen -x_noenv option to not expand environment variables
@ferdymercury
Copy link
Contributor Author

Thanks for the fix!

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Mar 10, 2022
@albert-github
Copy link
Collaborator

Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release).

@doxygen
Copy link
Owner

doxygen commented May 5, 2022

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.9.4.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label May 5, 2022
@doxygen doxygen closed this as completed May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug
Projects
None yet
Development

No branches or pull requests

3 participants