Cutter docs update #2259

Surendrajat · 2020-06-21T02:07:55Z

Some updates to the Cutter docs.

Your checklist for this pull request

I've read the guidelines for contributing to this repository
I made sure to follow the project's coding style
I've updated the documentation with the relevant information (if needed)

Detailed description
This PR has the following:

Move building errors from common errors to building page and move rest under user-docs/common-issues
Title capitalization (IDK I'm obsessed with it xD)
Updated troubleshooting part with git submodule related error
Apply Grammarly suggestions on all the docs

Test plan (required)
Build and run docs.

Closing issues
Partially close$ #744

Surendrajat · 2020-06-27T13:10:42Z

I've added a widget page with few moving screenshots(WIP). Let me know what you think.

karliss · 2020-06-27T13:46:08Z

I would be much happier if documentation was moved to separate repository before adding a bunch of screenshots for all the widgets and dialogs. Those could quickly cause bloat.

XVilka · 2020-06-27T13:51:40Z

It can be made a submodule to keep the old structure.

…

On Sat, Jun 27, 2020, 21:46 karliss ***@***.***> wrote: I would be much happier if documentation was moved to separate repository before adding a bunch of screenshots for all the widgets and dialogs. Those could quickly cause bloat. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://github.com/radareorg/cutter/pull/2259#issuecomment-650563261>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABRT7MVWMXNXH3J64I7G2DRYXZ2ZANCNFSM4ODUP3LA> .

Surendrajat · 2020-06-27T14:17:57Z

I see #2056 open for just this. If it's done I can move things there.
As for submodule, I think it'll add additional commits to this repo on each update to docs, which will probably be better if avoided. How about splitting API docs and other docs and leave API docs here?

ITAYC0HEN · 2020-07-18T10:39:43Z

You might want to consider adding the :menuselection: and :guilabel: to the docs as part of this or another PR. @karliss found these features just recently

https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html

Surendrajat · 2020-07-21T16:47:00Z

@karliss I've removed the widget intro part and will open another PR to continue work on that until we decide if to split repo or not.

docs/source/index.rst

ITAYC0HEN

Fantastic work!

docs/source/building.rst

ITAYC0HEN · 2020-07-22T12:35:12Z

docs/source/building.rst

+``/usr/local/bin``). That can be, for example, due to ``Qt Creator.app``
+being copied over to ``/Applications``. To fix this, append
+``:/usr/local/bin`` to the ``PATH`` variable within the *Build
+Environment* section in Qt Creator. See the screenshot below should you


Only Qt Creator?

I copied it from common-errors :( Not much idea. Will see what I can do :P

ITAYC0HEN · 2020-07-22T12:36:24Z

docs/source/building.rst

+-  ``PKG_CONFIG_PATH=$HOME/cutter/radare2/pkgcfg qmake`` (for modern
+   version and if radare2 was installed like the submodule)


What is this "modern version"? Maybe should be more specific (e.g for versions newer than 1.2.3.4, ....)

Would rephrase "was installed like the submodule" because the meaning isn't that clear

docs/source/contributing/code/development-guidelines.rst

docs/source/user-docs/command-line.rst

ITAYC0HEN · 2020-07-22T12:45:36Z

docs/source/user-docs/common-issues.rst

+
+If the Linux AppImage binary crashes upon startup, make sure your
+``LD_LIBRARY_PATH`` environment variable is empty.
+`#579 <https://github.com/radareorg/cutter/issues/579>`__


Seems like this weird number is just thrown there out of no-where. Try to add an opening sentence to introduce the number. "For a detailed explanation see issue #1234"

docs/source/user-docs/menus/disassembly-context-menu.rst

ITAYC0HEN · 2020-07-22T12:50:19Z

docs/source/user-docs/menus/disassembly-context-menu/debug-context-menu.rst

 ----------------------------------------
 **Description:** Continue the execution of the program until reached the selected offset. The program is not guaranteed to ever reach this address and will keep running until exited or until reached another breakpoint. If other breakpoints hit before reaching this line, they will be triggered and pause the execution. *This option is only available on Debug or Emulation modes*.      

 **Steps:** While in Debug or Emulation modes, right-click and address and choose ``Debug -> Continue until line``.  

 Set Program Counter (PC)
 ----------------------------------------
-**Description:** Set the Program Counter of the debuggee to the current offset. For example, on Intel 64bit program, Cutter will set the value of the RIP register to the curren address.  *This option is only available on Debug or Emulation modes*.  
+**Description:** Set the Program Counter of the debugger to the current offset. For example, on a Intel 64bit program, Cutter will set the value of the RIP register to the current address.  *This option is only available on Debug or Emulation modes*.  


The "debuggee" here is intentional -> https://wikidiff.com/debugger/debuggee

ITAYC0HEN · 2020-07-25T17:44:48Z

is there anything left to do?

Surendrajat · 2020-07-25T17:57:03Z

is there anything left to do?

Yes. Finishing right away. :P

ITAYC0HEN

Looks good! I love this pr :)

* move building errors to the troubleshooting section * add submodule out of sync issue to troubleshooting * changes to get cutter section * move common issues to user docs * add error related to submodule not in sync * Grammarly scan on all the docs * update contribution guide now that common-errors is split

Surendrajat marked this pull request as draft June 21, 2020 02:14

Surendrajat mentioned this pull request Jun 27, 2020

Rename a context menu item #2267

Merged

3 tasks

Surendrajat force-pushed the docs-update branch from 93094de to e01265d Compare June 27, 2020 08:07

Surendrajat marked this pull request as ready for review June 27, 2020 13:05

Surendrajat changed the title ~~Cutter docs update~~ [WIP] Cutter docs update Jun 27, 2020

ITAYC0HEN added the Documentation label Jul 16, 2020

Surendrajat marked this pull request as draft July 16, 2020 14:04

Surendrajat changed the title ~~[WIP] Cutter docs update~~ Cutter docs update Jul 21, 2020

Surendrajat force-pushed the docs-update branch 2 times, most recently from b3f8346 to 4528ae9 Compare July 21, 2020 16:21

Surendrajat marked this pull request as ready for review July 21, 2020 16:45

Surendrajat requested a review from a team July 21, 2020 17:05

karliss reviewed Jul 21, 2020

View reviewed changes

docs/source/index.rst Outdated Show resolved Hide resolved

Surendrajat force-pushed the docs-update branch from ef760b6 to 72d99d8 Compare July 22, 2020 01:42

Surendrajat requested review from karliss and ITAYC0HEN July 22, 2020 01:45

ITAYC0HEN requested changes Jul 22, 2020

View reviewed changes

Surendrajat added 5 commits July 25, 2020 23:41

move building errors to troubleshooting section

79bcc0d

Now its just common-issues, no errors

37cd07e

Cosmetic

a0d7eab

add submodule out of sync issue to troubleshooting

a68c01a

changes to get cutter section

d278648

Surendrajat added 8 commits July 25, 2020 23:41

just wordings, nothing else

c1a2472

move common issues to user docs

dc4857c

submodule update not sync

1a83251

Not sure why it didn't work without extension locally

53ce584

use Sphinx doc linking

ee637d3

grammarly scan on all the docs

e2acaed

apply suggestions

f0ee2b9

since common-errors is splitted, better to update contribution guide

b538265

Surendrajat force-pushed the docs-update branch from 83727d6 to b538265 Compare July 25, 2020 18:49

Surendrajat requested a review from ITAYC0HEN July 25, 2020 18:49

one more suggestion (I really don't know version)

a132a8f

ITAYC0HEN approved these changes Jul 25, 2020

View reviewed changes

Surendrajat merged commit 79b2314 into rizinorg:master Jul 26, 2020

Surendrajat deleted the docs-update branch July 26, 2020 04:59

Surendrajat mentioned this pull request Jul 26, 2020

Initial widget docs #2333

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cutter docs update #2259

Cutter docs update #2259

Surendrajat commented Jun 21, 2020 •

edited

Loading

Surendrajat commented Jun 27, 2020

karliss commented Jun 27, 2020

XVilka commented Jun 27, 2020 via email

Surendrajat commented Jun 27, 2020

ITAYC0HEN commented Jul 18, 2020

Surendrajat commented Jul 21, 2020

ITAYC0HEN left a comment

ITAYC0HEN Jul 22, 2020

Surendrajat Jul 22, 2020 •

edited

Loading

ITAYC0HEN Jul 22, 2020

ITAYC0HEN Jul 22, 2020

ITAYC0HEN Jul 22, 2020

ITAYC0HEN Jul 22, 2020

ITAYC0HEN commented Jul 25, 2020

Surendrajat commented Jul 25, 2020

ITAYC0HEN left a comment

		- ``PKG_CONFIG_PATH=$HOME/cutter/radare2/pkgcfg qmake`` (for modern
		version and if radare2 was installed like the submodule)

Cutter docs update #2259

Cutter docs update #2259

Conversation

Surendrajat commented Jun 21, 2020 • edited Loading

Surendrajat commented Jun 27, 2020

karliss commented Jun 27, 2020

XVilka commented Jun 27, 2020 via email

Surendrajat commented Jun 27, 2020

ITAYC0HEN commented Jul 18, 2020

Surendrajat commented Jul 21, 2020

ITAYC0HEN left a comment

Choose a reason for hiding this comment

ITAYC0HEN Jul 22, 2020

Choose a reason for hiding this comment

Surendrajat Jul 22, 2020 • edited Loading

Choose a reason for hiding this comment

ITAYC0HEN Jul 22, 2020

Choose a reason for hiding this comment

ITAYC0HEN Jul 22, 2020

Choose a reason for hiding this comment

ITAYC0HEN Jul 22, 2020

Choose a reason for hiding this comment

ITAYC0HEN Jul 22, 2020

Choose a reason for hiding this comment

ITAYC0HEN commented Jul 25, 2020

Surendrajat commented Jul 25, 2020

ITAYC0HEN left a comment

Choose a reason for hiding this comment

Surendrajat commented Jun 21, 2020 •

edited

Loading

Surendrajat Jul 22, 2020 •

edited

Loading