Skip to content

Add reference page for mc du #783

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
merged 5 commits into from
Mar 30, 2023
Merged

Add reference page for mc du #783

merged 5 commits into from
Mar 30, 2023

Conversation

feorlen
Copy link
Collaborator

@feorlen feorlen commented Mar 29, 2023 •
edited
Loading

Create a new reference page for mc du and link it in the list of mc commands.

Staged:
http://192.241.195.202:9000/staging/DOCS-764/linux/html/reference/minio-mc/mc-du.html

Includes drive-by fixes to make the Optional notations appear in a more consistent manner. (Including several otherwise unrelated pages.) There's more opportunistic fixes here than I might normally do in the same PR, but seemed better to get it over with.

Fixes #764

feorlen
feorlen commented Mar 29, 2023
View reviewed changes
source/includes/common-minio-mc.rst
@@ -30,7 +30,7 @@ This command supports only global flags
.. start-minio-mc-s3-compatibility

The :program:`mc` commandline tool is built for compatibility with the AWS S3
API and is tested MinIO and AWS S3 for expected functionality and behavior.
API and is tested with MinIO and AWS S3 for expected functionality and behavior.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Drive-by typo fix

feorlen
feorlen commented Mar 29, 2023
View reviewed changes
source/includes/facts-versioning.rst
@@ -1,6 +1,6 @@
.. start-rewind-desc

*Optional* Directs |command| to operate only on the object version(s) that
Directs |command| to operate only on the object version(s) that
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Remove the manually formatted *Optional* from rewind and versions so it can be done with :optional: in the place this content is included.

Other includes have the same issue, but these two are the ones my new page uses.

feorlen
feorlen commented Mar 29, 2023
View reviewed changes
source/reference/minio-mc/mc-ls.rst
@@ -42,7 +42,7 @@ results as the ``ls`` command.

mc ls --recursive --versions myminio/mydata

The output resembles the following::
The output resembles the following:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Another opportunistic typo fix.

ravindk89
ravindk89 approved these changes Mar 29, 2023
View reviewed changes
Copy link
Collaborator

@ravindk89 ravindk89 left a comment

Choose a reason for hiding this comment

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

LGTM mod nit!

@feorlen feorlen requested a review from djwfyi March 29, 2023 23:11
ravindk89
ravindk89 approved these changes Mar 29, 2023
View reviewed changes
Copy link
Collaborator

@ravindk89 ravindk89 left a comment

Choose a reason for hiding this comment

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

Still LGTM with one more nit :D

@feorlen @ravindk89
Fix spurious line break
1c30e83 
Co-authored-by: Ravind Kumar <ravind@min.io>
@harshavardhana
Copy link
Member

We should warn as the amount of data gets big, mc du might take a long time to finish @feorlen

@feorlen
Copy link
Collaborator Author

feorlen commented Mar 30, 2023 •
edited
Loading

We should warn as the amount of data gets big, mc du might take a long time to finish

That would be helpful for folks less accustomed to the OS versions of du, good idea. Is there anything meaningful we could say about expectations? (Not like I've ever gotten that from a man page...)

Update: I added a general comment about execution time. There are so many possible considerations, after all.

djwfyi
djwfyi approved these changes Mar 30, 2023
View reviewed changes
Copy link
Collaborator

@djwfyi djwfyi left a comment

Choose a reason for hiding this comment

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

A few suggestions to remove some links so it's not a sea of blue fields when reading.
One additional drive-by typo I noticed that could be fixed with this PR.

Otherwise, LGTM! Great work on this one!

@feorlen feorlen merged commit 1f8ce6d into main Mar 30, 2023
@feorlen feorlen deleted the DOCS-764 branch March 30, 2023 19:36
feorlen added a commit that referenced this pull request Mar 30, 2023
@feorlen
Reapply missing commit from PR 783: mc du
ca1cd49 
Small text and formatting edits. Lost due to network outage, oops.

Original PR: #783
Original issue: #764
@feorlen feorlen mentioned this pull request Mar 30, 2023
Merged
djwfyi pushed a commit that referenced this pull request Mar 30, 2023
@feorlen
Reapply missing commit from PR 783: mc du (#789)
c1a84f7 
Small text and formatting edits. Lost due to network outage, oops.

Original PR: #783
Original issue: #764
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ravindk89 ravindk89 ravindk89 approved these changes

@djwfyi djwfyi djwfyi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add reference docs for mc du
4 participants
@feorlen @harshavardhana @ravindk89 @djwfyi