Skip to content

doc.d: move file writes to caller #15535

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.

Sign up for GitHub

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

Jump to bottom
Merged
dlang-bot merged 1 commit into from
Aug 13, 2023
Merged

doc.d: move file writes to caller #15535

dlang-bot merged 1 commit into from
Aug 13, 2023

Conversation

@WalterBright
Copy link
Member

@WalterBright WalterBright commented Aug 13, 2023

By doing this:

  1. gendocfile is relieved of any need for dealing with files and can concentrate on just generating the ddoc text
  2. the buffer memory can be recycled instead of free'd and alloc'd again
  3. the error handling is now the caller's problem
  4. doc.d doesn't need to import errors.d anymore
  5. the caller can now decide what to do with the generated output

@WalterBright WalterBright added the Severity:Refactoring No semantic changes to code label Aug 13, 2023
@WalterBright WalterBright requested a review from ibuclaw as a code owner August 13, 2023 05:48
@dlang-bot
Copy link
Contributor

dlang-bot commented Aug 13, 2023

Thanks for your pull request, @WalterBright!

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

Testing this PR locally

If you don't have a local development environment setup, you can use Digger to test this PR:

dub run digger -- build "master + dmd#15535"

@WalterBright
Copy link
Member Author

WalterBright commented Aug 13, 2023

Hmm, I'm going to have to resort to changing this a bit at a time until I find what went wrong.

@dlang-bot dlang-bot merged commit db216af into dlang:master Aug 13, 2023
@WalterBright WalterBright deleted the ddoctext branch August 13, 2023 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thewilsonator thewilsonator thewilsonator approved these changes

@ibuclaw ibuclaw Awaiting requested review from ibuclaw ibuclaw is a code owner

Assignees

No one assigned

Labels

Merge:auto-merge Severity:Refactoring No semantic changes to code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@WalterBright @dlang-bot @thewilsonator