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

Document --heap-size-hint in Command-line Interface #50480

Merged
merged 2 commits into from
Feb 8, 2024

Conversation

KnutAM
Copy link
Contributor

@KnutAM KnutAM commented Jul 9, 2023

Almost a direct copy of the output in julia --help.

I would find it helpful with a short note (if possible) on how to calculate the current memory usage to be compared with this value (which is why I was looking for the docs in the first place, so I don't know how to do that...)

Closes #50588

@brenhinkeller brenhinkeller added the domain:docs This change adds or pertains to documentation label Aug 5, 2023
@nsajko
Copy link
Contributor

nsajko commented Aug 21, 2023

maybe merge?

@Seelengrab
Copy link
Contributor

I don't know when it was added, but this option is documented in --help now.

@Seelengrab Seelengrab closed this Nov 14, 2023
@KnutAM
Copy link
Contributor Author

KnutAM commented Nov 14, 2023

It was available via --help before, it is just not available in the online documentation. I think this is still not there in master (cannot find it in https://github.com/julialang/julia/blob/master/doc/src/manual/command-line-interface.md). But I'm also fine with closing this if it would get in via #50843, but looks like that one stalled too.

@Seelengrab
Copy link
Contributor

Seelengrab commented Nov 14, 2023

Ah, sorry about that - I thought you were talking about the command line option! My bad, reopening. The PR looks good to me.

@Seelengrab Seelengrab reopened this Nov 14, 2023
Copy link
Contributor

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@fingolfin fingolfin added the status:merge me PR is reviewed. Merge when all tests are passing label Feb 8, 2024
@fingolfin fingolfin added the backport 1.10 Change should be backported to the 1.10 release label Feb 8, 2024
@KristofferC KristofferC merged commit c5ad467 into JuliaLang:master Feb 8, 2024
7 of 10 checks passed
@inkydragon inkydragon removed the status:merge me PR is reviewed. Merge when all tests are passing label Feb 8, 2024
@KnutAM KnutAM deleted the patch-1 branch February 9, 2024 04:40
KristofferC pushed a commit that referenced this pull request Feb 20, 2024
Almost a direct copy of the output in `julia --help`.

Closes #50588

Co-authored-by: Max Horn <[email protected]>
(cherry picked from commit c5ad467)
@KristofferC KristofferC mentioned this pull request Feb 20, 2024
19 tasks
KristofferC pushed a commit that referenced this pull request Feb 26, 2024
Almost a direct copy of the output in `julia --help`.

Closes #50588

Co-authored-by: Max Horn <[email protected]>
(cherry picked from commit c5ad467)
KristofferC added a commit that referenced this pull request Feb 27, 2024
Backported PRs:
- [x] #53205 <!-- Profile: add notes to `print()` docs -->
- [x] #53170 <!-- Remove outdated discussion about externally changing
module bindings -->
- [x] #53228 <!-- SubArray: avoid invalid elimination of singleton
indices -->
- [x] #51361 <!-- code_warntype docs: more neutral reference to
@code_warntype -->
- [x] #50480 <!-- Document --heap-size-hint in Command-line Interface
-->
- [x] #53301 <!-- Fix typo in `Sys.total_memory` docstring. -->
- [x] #53354 <!-- fix code coverage bug in tail position and `else` -->
- [x] #53388 <!-- Fix documentation: thread pool of main thread -->
- [x] #53429 <!-- Subtype: skip slow-path in `local_∀_∃_subtype` if
inputs contain no ∃ typevar. -->
- [x] #53437 <!-- Add debug variant of loader_trampolines.o -->

Need manual backport:
- [ ] #52505 <!-- fix alignment of emit_unbox_store copy -->
- [ ] #53373 <!-- fix sysimage-native-code=no option with pkgimages -->
- [ ] #53439 <!-- staticdata: fix assert from partially disabled native
code -->

Contains multiple commits, manual intervention needed:
- [ ] #52913 <!-- Added docstring for Artifacts.jl -->
- [ ] #53218 <!-- Fix interpreter_exec.jl test -->

Non-merged PRs with backport label:
- [ ] #53424 <!-- yet more atomics & cache-line fixes on work-stealing
queue -->
- [ ] #53125 <!-- coverage: count coverage where explicitly requested by
inference only -->
- [ ] #52694 <!-- Reinstate similar for AbstractQ for backward
compatibility -->
- [ ] #51479 <!-- prevent code loading from lookin in the versioned
environment when building Julia -->
@KristofferC KristofferC removed the backport 1.10 Change should be backported to the 1.10 release label Mar 12, 2024
Drvi pushed a commit to RelationalAI/julia that referenced this pull request Jun 7, 2024
Almost a direct copy of the output in `julia --help`.

Closes JuliaLang#50588

Co-authored-by: Max Horn <[email protected]>
(cherry picked from commit c5ad467)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention --heap-size-hint in Command-line Interface page
7 participants