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

mkswap: add page #1984

Merged
merged 5 commits into from
Feb 12, 2018
Merged

mkswap: add page #1984

merged 5 commits into from
Feb 12, 2018

Conversation

shashank2806
Copy link
Contributor


  • The page (if new), does not already exist in the repo.

  • The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • The page has 8 or fewer examples.

  • The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited.

  • The page follows the contributing guidelines.

@tldr-bot
Copy link

The build for this PR has failed with the following error(s):

pages/linux/mkswap.md:4: TLDR003 Descriptions should start with a capital letter

Please fix the error(s) and push again.

Copy link

@rishavpandey43 rishavpandey43 left a comment

Choose a reason for hiding this comment

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

Good Work!

Your description is also good.

Copy link
Member

@agnivade agnivade left a comment

Choose a reason for hiding this comment

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

Thanks for the PR !

Would you like to add -L and -c options too ? I believe they are useful and should be in the page.


- Setup a disk partition as swap area:

`sudo mkswap {{partition}}`
Copy link
Member

Choose a reason for hiding this comment

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

Let us use a concrete example like /dev/sdb1 rather than partition

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


- Setup a file and use that file as swap space:

`sudo mkswap {{filename}}`
Copy link
Member

Choose a reason for hiding this comment

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

filename => path/to/file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done !


`sudo mkswap {{partition}}`

- Setup a file and use that file as swap space:
Copy link
Member

Choose a reason for hiding this comment

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

What does it mean to "Setup a file" ? Does it make sense to just say Use a given file as swap area: ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

@shashank2806
Copy link
Contributor Author

shashank2806 commented Feb 11, 2018

Thanks for suggestion!

I added those changes suggested by you.

@agnivade agnivade added the new command Issues requesting creation of a new page. label Feb 11, 2018
- Updated the description to use the word "partition"
- Removed a preceding slash from file
- Added a line on using swapon to make it more helpful
Copy link
Member

@agnivade agnivade left a comment

Choose a reason for hiding this comment

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

I made some very minor changes which makes the page a bit more consistent with the other pages. Hope that is fine by you.

Thanks for the contribution :)

@shashank2806
Copy link
Contributor Author

shashank2806 commented Feb 11, 2018

Thanks for making corrections.

I am glad to be part of tldr community.

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, @shashank2806 - looks ok to me! 😺
Can't believe we didn't have this page before :P

@sbrl sbrl merged commit c67396e into tldr-pages:master Feb 12, 2018
@shashank2806 shashank2806 deleted the patch-1 branch February 13, 2018 08:58
lamar-frankie pushed a commit to lamar-frankie/tldr that referenced this pull request Jun 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants