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

Add docs clarifying list-doc and install-doc #754

Merged
merged 11 commits into from
Jan 23, 2024

Conversation

rectalogic
Copy link
Contributor

Fixes #753

Copy link
Contributor

@ddalcino ddalcino left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! This is definitely an improvement.

Please see the suggested changes below. These are my initial thoughts on how to make this section a little more clear; they are not perfect, but I'll bet we can collectively come up with something better.

docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
rectalogic and others added 4 commits January 19, 2024 12:00
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
@rectalogic
Copy link
Contributor Author

@ddalcino thanks. So one thing I noticed is list-doc does not accept --archives. So for example the qtmultimedia module consists of 2 archives - qtmultimedia and qtspatialaudio.

So if I only want the qtmultimedia docs, I need to do install-doc mac 6.6.1 --modules qtmultimedia --archives qtmultimedia - if I just do install-doc mac 6.6.1 --modules qtmultimedia then it installs all the default archives plus qtmultimedia and qtspatialaudio docs.

But I don't see a way to figure this out from list-doc. I would just have to install --modules qtmultimedia and realize it is installing multiple modules, then run it again filtering down the archives I guess.

So basically the archives that make up a module are hidden from list-doc - it can only show the default set of archives, or the list of modules. But not the archives that a module consists of.

@ddalcino
Copy link
Contributor

You are correct. In general, there is only a single archive for each module, except for the base module and the debug_info module, which only exists for some platforms when installing Qt (not src/doc/examples).

There are a few edge cases, like this one, where a module contains 2 or more archives.

The purpose of the --archives command is really to help reduce download times and data usage, and I think it does that well enough. I don't think it's worth the maintenance cost to enable it for a couple edge cases here to save a couple kilobytes.

You're welcome to document this as well if it really bothers you.

docs/getting_started.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@pzhlkj6612 pzhlkj6612 left a comment

Choose a reason for hiding this comment

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

Wording wording.

docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
Copy link
Owner

@miurahr miurahr left a comment

Choose a reason for hiding this comment

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

Confirmed suggested wording improvements.

rectalogic and others added 6 commits January 22, 2024 10:20
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
@pzhlkj6612
Copy link
Contributor

A GitHub pro tip for @rectalogic:

We are able to apply a batch of changes during code reviewing: Incorporating feedback in your pull request - GitHub Docs.

Copy link
Contributor

@pzhlkj6612 pzhlkj6612 left a comment

Choose a reason for hiding this comment

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

I didn't test the code, but have read the docs. It looks OK to me.

Copy link
Contributor

@ddalcino ddalcino left a comment

Choose a reason for hiding this comment

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

LGTM. I ran the code and it does exactly what the code-block sections say they will.

@miurahr miurahr merged commit 61e18c8 into miurahr:master Jan 23, 2024
4 checks passed
@rectalogic rectalogic deleted the install-doc branch April 11, 2024 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Some documentation archives not found by list-doc
4 participants