Skip to content

Conversation

@spirillen
Copy link
Contributor

@spirillen spirillen commented Jul 20, 2021

spirillen added 5 commits July 4, 2021 13:21
Have made some notes about the limitation of running Cygwin or Python on a Windows and how it is affecting @PyFunceble

Signed by @spirillen
With this release I have made some minor textual changes, but big changes to the filestructure as I have renamed the files inside docs/usage/. This is done to make the filename + the titles more systematic and equal, it just leaves the "mess" it used to be.

Signed by @spirillen
Ensuring that no misunderstands the .PyFunceble.yaml is overwritten by default since .PyFunceble.overwrite.yaml was introduced.
@coveralls
Copy link

coveralls commented Jul 20, 2021

Coverage Status

Coverage remained the same at 97.819% when pulling 999d279 on spirillen:4.x-doc into 35d1ff2 on funilrys:dev.

Copy link
Owner

@funilrys funilrys left a comment

Choose a reason for hiding this comment

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

Please don't rename to bash-terminal.rst. A lot of people already have that on their bookmark.

Please also fix my comments regarding heading. The "Deprecated Variables" section is included and embedded inside the "From Terminal" section.

@@ -1,127 +1,127 @@
Deprecated variables
^^^^^^^^^^^^^^^^^^^^
--------------------
Copy link
Owner

Choose a reason for hiding this comment

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

This file is included. Please don't change the heading level.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Damned... will need to put on my thinking hat then... as the heading actually was the issue for why I changed them. (just don't recall where i spotted it)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now I remember and I will encourage you to try to make a local build your self, to see the new index ordering under Usage

Personally I think it is looking way better AND it make it easier to find the "Deprecated variables" as you no longer need to go all the way through "From a terminal"

It is also easier to link to a specific old value under issues and / Or discussions

image

image

image

Try it your self and let me know what you think when you have tried it 😏

I put a 🍨 on the line your will change your mind 😃

Copy link
Owner

Choose a reason for hiding this comment

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

The problem is that they are not variables ... They are CLI arguments @spirillen ...

That's why they are in there....

We have 2 options ...

  1. Reverse as it was.
  2. List the old and new configuration keys along with the --arguments.

Copy link
Contributor Author

@spirillen spirillen Sep 5, 2021

Choose a reason for hiding this comment

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

  1. Rename deprecated-variables.rst to deprecated-arguments.rst
    1. Rename plus keeping all arguments collected in one file
      1. Pitfall is the long list of "useless" arguments vs
      2. One list of ACTIVE arguments
      3. One list of deprecated arguments

This would actually be better as you mention yourself, they are arguments, not variables.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The problem is that they are not variables ... They are CLI arguments @spirillen ...

That's why they are in there....

We have 2 options ...

1. Reverse as it was.

2. List the old and new configuration keys along with the `--arguments`.

Experimental filenaming for deprecated args
https://mypdns.org/spirillen/PyFunceble/-/commit/008368aee770e73aaca5c7da349337a20c51f538


:code:`-ad`
"""""""""""
^^^^^^^^^^^
Copy link
Owner

Choose a reason for hiding this comment

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

Don't change the heading level.


:code:`-nw` | :code:`--no-whois`
""""""""""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Owner

Choose a reason for hiding this comment

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

Don't change the heading level.


:code:`--shadow-file` | :code:`--shadow`
""""""""""""""""""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Owner

Choose a reason for hiding this comment

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

Don't change the heading level.


:code:`--multiprocess-merging-mode`
"""""""""""""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Owner

Choose a reason for hiding this comment

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

Don't change the heading level.


:code:`--autosave-minutes`
""""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Owner

Choose a reason for hiding this comment

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

Don't change the heading level.


:code:`--cmd`
"""""""""""""
^^^^^^^^^^^^^
Copy link
Owner

Choose a reason for hiding this comment

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

Don't change the heading level.


:code:`--cmd-before-end`
""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Owner

Choose a reason for hiding this comment

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

Don't change the heading level.


.. include:: with-our-python-api.rst
.. include:: from-a-terminal.rst
.. include:: bash-terminal.rst
Copy link
Owner

Choose a reason for hiding this comment

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

Please keep order.

  • Python API First
  • Terminal (please reverse filename as it is in many bookmarks already).
  • Deprecated Variables
  • GitHub Action
  • GitLab CI/CD
  • Travis CI

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As it makes most seance with the new name I'll rather suggest a "empty" from-a-terminal.rst which either

  • informs of new location
  • Include the 'bash-terminal.rst'

Copy link
Owner

Choose a reason for hiding this comment

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

A powershell is a terminal.
A bash is a terminal.
PyFunceble can be used in both.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A powershell is a terminal.
A bash is a terminal.
PyFunceble can be used in both.

True, but also the very same syntax you are using in bash scripting... Which is the intention for renaming the file, to have it's name indicating that this is not ONLY for CLI command but also highly programmable commands too.

I'll give it another thought when it no longer is To Hot To Be Human

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A brainstorm for handling the naming of from-a-terminal.rst to something more corvering of terminal + scripting

  • terminal-scripting.rst
  • scripting-terminal.rst
  • ??

Another alternative could be to split it into 3 files

  • scripting-sh.rst
    • .. include::args.rst
  • scripting-ps.rst
    • .. include::args.rst
  • terminal.rst
    • .. include::args.rst
  • args.rst

This will in the long run make it possible to make some more specific and in-depth explanation related to each of the different processes as IE Pyfunceble in bash/sh scripts is running as a sub-process and hence arguments should be parsed as uppercase

.. NOTE:: I'm really going for a rename of from-a-terminal.rst as it have become to "OFF" in its name compared to the rest of the dirs files.

New title: (Line 12)

Usage from a terminal or for scripting
-------------------------------------------------

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Mostly to self + @funilrys

We should consider this one before switching from beta

https://mypdns.org/spirillen/PyFunceble/-/issues/26

Copy link
Owner

Choose a reason for hiding this comment

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

Mhhhh terminal.rst is okay for me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@funilrys funilrys linked an issue Jul 25, 2021 that may be closed by this pull request
@funilrys funilrys removed a link to an issue Jul 25, 2021
Forgot to update the docs/usage/idex.rst to meet the new filename of terminal.rst.
And a few missing duble lines between arguments

Previous commit within same PR tuched https://mypdns.org/spirillen/PyFunceble/-/issues/26
I also spotted a few lines, which was pushing the 72 chars per line boundries.

(72 vs 80 chars per line, for support of Unix consoles)

This commit tuches #246 to better desription of the .PyFunceble.overwrite.yaml as requested by @ZeroDot1
@funilrys funilrys closed this in cf62c4b Sep 8, 2021
funilrys added a commit that referenced this pull request Sep 20, 2021
Contributors:
  * @spirillen

Squashed commit of the following:

commit 6b88f56
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 13 09:42:58 2021 +0200

    Fixing a BUG in the code example

    By a mistake there was written `-url "$URI"` which of curse should have been `-u "$URI"`. The mistake was spotted in easylist/easylist#9061 (comment) posted by @ryanbr

commit 2e99711
Merge: 955ae63 7254cfd
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 13 09:36:51 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 955ae63
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 6 11:24:37 2021 +0200

    Wrote in depth about .PyFunceble.overwrite.yaml

    I also spotted a few lines, which was pushing the 72 chars per line boundries.

    (72 vs 80 chars per line, for support of Unix consoles)

    This commit tuches #246 to better desription of the .PyFunceble.overwrite.yaml as requested by @ZeroDot1

commit e5c687b
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 15:01:38 2021 +0200

    Small rewrite of the intro in terminal.rst

    And a few missing duble lines between arguments

    Previous commit within same PR tuched https://mypdns.org/spirillen/PyFunceble/-/issues/26

commit 6786933
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:50:03 2021 +0200

    Update index.rst in docs

    Forgot to update the docs/usage/idex.rst to meet the new filename of terminal.rst.

commit 36dca1f
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:48:40 2021 +0200

    Rename bash-terminal.rst to terminal.rst

    Fixes #247 (comment)

commit 008368a
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:46:21 2021 +0200

    Experimental filenaming for deprecated args

    Relates to #247 (comment)

    fix #247 (comment)

    Signed by @spirillen

commit 419c3bd
Merge: 999d279 59b809f
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:20:42 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 999d279
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Aug 2 15:10:50 2021 +0200

    Ordering the Usage docs

    Fixed a small Wording

    Refs: #247 (comment)

    Signed by @spirillen

commit 655d67f
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Aug 2 14:59:59 2021 +0200

    Updated example IP's to RFC:5737

    Signed by @spirillen

commit 631196c
Merge: 132f2e0 35d1ff2
Author: Spirillen <pdns@protonmail.com>
Date:   Tue Jul 20 13:54:15 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 132f2e0
Author: spirillen <pdns@protonmail.com>
Date:   Tue Jul 20 11:50:31 2021 +0000

    Tiny fixup of the text for .PyFunceble.yaml

    Ensuring that no misunderstands the .PyFunceble.yaml is overwritten by default since .PyFunceble.overwrite.yaml was introduced.

commit 1db47e6
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Jul 4 15:15:10 2021 +0200

    Major changes to docs/

    With this release I have made some minor textual changes, but big changes to the filestructure as I have renamed the files inside docs/usage/. This is done to make the filename + the titles more systematic and equal, it just leaves the "mess" it used to be.

    Signed by @spirillen

commit 3a4d95c
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Jul 4 13:44:50 2021 +0200

    Added Power(less)shell to the title for know Windows issues...

    Signed by @spirillen

commit d9006c7
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Jul 4 13:21:40 2021 +0200

    Knowen Issue Cygwin

    Have made some notes about the limitation of running Cygwin or Python on a Windows and how it is affecting @PyFunceble

    Signed by @spirillen
funilrys pushed a commit that referenced this pull request Sep 21, 2021
Contributors:
  * @spirillen 

* Knowen Issue Cygwin

Have made some notes about the limitation of running Cygwin or Python on a Windows and how it is affecting @PyFunceble

Signed by @spirillen

* Added Power(less)shell to the title for know Windows issues...

Signed by @spirillen

* Major changes to docs/

With this release I have made some minor textual changes, but big changes to the filestructure as I have renamed the files inside docs/usage/. This is done to make the filename + the titles more systematic and equal, it just leaves the "mess" it used to be.

Signed by @spirillen

* Tiny fixup of the text for .PyFunceble.yaml

Ensuring that no misunderstands the .PyFunceble.yaml is overwritten by default since .PyFunceble.overwrite.yaml was introduced.

* Updated example IP's to RFC:5737

Signed by @spirillen

* Ordering the Usage docs

Fixed a small Wording

Refs: #247 (comment)

Signed by @spirillen

* Experimental filenaming for deprecated args

Relates to #247 (comment)

fix #247 (comment)

Signed by @spirillen

* Rename bash-terminal.rst to terminal.rst

Fixes #247 (comment)

* Update index.rst in docs

Forgot to update the docs/usage/idex.rst to meet the new filename of terminal.rst.

* Small rewrite of the intro in terminal.rst

And a few missing duble lines between arguments

Previous commit within same PR tuched https://mypdns.org/spirillen/PyFunceble/-/issues/26

* Wrote in depth about .PyFunceble.overwrite.yaml

I also spotted a few lines, which was pushing the 72 chars per line boundries.

(72 vs 80 chars per line, for support of Unix consoles)

This commit tuches #246 to better desription of the .PyFunceble.overwrite.yaml as requested by @ZeroDot1

* Fixing a BUG in the code example

By a mistake there was written `-url "$URI"` which of curse should have been `-u "$URI"`. The mistake was spotted in easylist/easylist#9061 (comment) posted by @ryanbr

* Written about how to speedup test with ramFS

Solved a few github link issues to @spirillen's profile

* Improvement of ramFS text

Have fixed markup of code-block
fixed markup of the indented paragraph and changed it to a info block, as it seems more right
Fixed the Url's

* Trying to fix typo and grammar.

Co-authored-by: Nissar Chababy <funilrys@protonmail.com>
Co-authored-by: Spirillen Marsupilami <spirillen@mypdns.org>
funilrys added a commit that referenced this pull request Nov 7, 2021
Contributors:
  * @spirillen

This patch merges #259.
Merge pull request #259.

Squashed commit of the following:

commit 3b6a1d28dea2b6d26bc5207b7b53101df7d95507
Author: funilrys <contact@funilrys.com>
Date:   Sun Nov 7 12:57:07 2021 +0100

    Introduction of an interface for memory profile.

    This patch touches #263.

commit cfbd2d525625e7fe61fc493256c42403bcf4bdf0
Author: funilrys <contact@funilrys.com>
Date:   Sun Nov 7 12:39:40 2021 +0100

    Avoid unnecessary copy.

commit 5649ce65b9010f4d5d69ff3829bf13f4cb31bf5f
Author: funilrys <contact@funilrys.com>
Date:   Thu Nov 4 05:58:42 2021 +0100

    Bump version to v4.0.2b2.

commit fbef5826a2f2fea3420eafe76e9d88b0cd16608b
Author: funilrys <contact@funilrys.com>
Date:   Thu Nov 4 05:56:55 2021 +0100

    Introduction of @T145 into list of contributors

    This patch touches #264.

commit ea818e273a116249e7e4a2da872d3ea170ee7b9f
Author: funilrys <contact@funilrys.com>
Date:   Thu Nov 4 05:53:57 2021 +0100

    Better handling of encoding around logo generation.

    This patch fixes #264.

    Contributors:
      * @T145

commit af9e7db
Author: Spirillen <pdns@protonmail.com>
Date:   Wed Oct 13 17:29:36 2021 +0200

    Updated links in they use(d) it

    1. Added link to https://github.com/mitchellkrogza/Phishing
    2. Updated link for _pornhosts (GH protection)
    3. Added new link for _porn-hosts as it old one was missing. GH took down
    the original path, so moved the source to mypdns and attentent the
    proper link as all releases are runned through @PyFunceble
    4. Added NSFW comments for links to mainly Anti Adult lists
    (GH protection)

commit 98ea33d
Merge: 20e33ec ffa0452
Author: Spirillen <pdns@protonmail.com>
Date:   Wed Oct 13 15:17:18 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 20e33ec
Merge: 8297888 c137639
Author: Spirillen Marsupilami <spirillen@mypdns.org>
Date:   Tue Sep 21 17:48:58 2021 +0200

    Merge branch '47-use-ramfs-for-faster-i-o-faster-test' into '4.x-doc'

    Resolve "use ramfs for faster I/O = faster test"

    Closes #47

    See merge request spirillen/PyFunceble!46

commit c137639
Author: Nissar Chababy <funilrys@protonmail.com>
Date:   Tue Sep 21 17:31:20 2021 +0200

    Trying to fix typo and grammar.

commit 779e495
Author: Spirillen <pdns@protonmail.com>
Date:   Tue Sep 21 01:56:05 2021 +0200

    Improvement of ramFS text

    Have fixed markup of code-block
    fixed markup of the indented paragraph and changed it to a info block, as it seems more right
    Fixed the Url's

commit 4d6f447
Merge: a1fe3fe 8297888
Author: Spirillen <pdns@protonmail.com>
Date:   Tue Sep 21 00:59:10 2021 +0200

    Merge remote-tracking branch 'origin/4.x-doc' into 47-use-ramfs-for-faster-i-o-faster-test

commit a1fe3fe
Merge: 34ebe7e 2cc6a5c
Author: Spirillen <pdns@protonmail.com>
Date:   Tue Sep 21 00:57:38 2021 +0200

    Merge remote-tracking branch 'origin/4.x-doc' into 47-use-ramfs-for-faster-i-o-faster-test

commit 8297888
Merge: 2cc6a5c 7c9a3f8
Author: Spirillen <pdns@protonmail.com>
Date:   Tue Sep 21 00:56:38 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 2cc6a5c
Merge: 6b88f56 0c30718
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 20 22:33:14 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 34ebe7e
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 20 11:37:03 2021 +0200

    Written about how to speedup test with ramFS

    Solved a few github link issues to @spirillen's profile

commit 6b88f56
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 13 09:42:58 2021 +0200

    Fixing a BUG in the code example

    By a mistake there was written `-url "$URI"` which of curse should have been `-u "$URI"`. The mistake was spotted in easylist/easylist#9061 (comment) posted by @ryanbr

commit 2e99711
Merge: 955ae63 7254cfd
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 13 09:36:51 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 955ae63
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Sep 6 11:24:37 2021 +0200

    Wrote in depth about .PyFunceble.overwrite.yaml

    I also spotted a few lines, which was pushing the 72 chars per line boundries.

    (72 vs 80 chars per line, for support of Unix consoles)

    This commit tuches #246 to better desription of the .PyFunceble.overwrite.yaml as requested by @ZeroDot1

commit e5c687b
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 15:01:38 2021 +0200

    Small rewrite of the intro in terminal.rst

    And a few missing duble lines between arguments

    Previous commit within same PR tuched https://mypdns.org/spirillen/PyFunceble/-/issues/26

commit 6786933
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:50:03 2021 +0200

    Update index.rst in docs

    Forgot to update the docs/usage/idex.rst to meet the new filename of terminal.rst.

commit 36dca1f
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:48:40 2021 +0200

    Rename bash-terminal.rst to terminal.rst

    Fixes #247 (comment)

commit 008368a
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:46:21 2021 +0200

    Experimental filenaming for deprecated args

    Relates to #247 (comment)

    fix #247 (comment)

    Signed by @spirillen

commit 419c3bd
Merge: 999d279 59b809f
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Sep 5 14:20:42 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 999d279
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Aug 2 15:10:50 2021 +0200

    Ordering the Usage docs

    Fixed a small Wording

    Refs: #247 (comment)

    Signed by @spirillen

commit 655d67f
Author: Spirillen <pdns@protonmail.com>
Date:   Mon Aug 2 14:59:59 2021 +0200

    Updated example IP's to RFC:5737

    Signed by @spirillen

commit 631196c
Merge: 132f2e0 35d1ff2
Author: Spirillen <pdns@protonmail.com>
Date:   Tue Jul 20 13:54:15 2021 +0200

    Merge remote-tracking branch 'upstream/dev' into 4.x-doc

commit 132f2e0
Author: spirillen <pdns@protonmail.com>
Date:   Tue Jul 20 11:50:31 2021 +0000

    Tiny fixup of the text for .PyFunceble.yaml

    Ensuring that no misunderstands the .PyFunceble.yaml is overwritten by default since .PyFunceble.overwrite.yaml was introduced.

commit 1db47e6
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Jul 4 15:15:10 2021 +0200

    Major changes to docs/

    With this release I have made some minor textual changes, but big changes to the filestructure as I have renamed the files inside docs/usage/. This is done to make the filename + the titles more systematic and equal, it just leaves the "mess" it used to be.

    Signed by @spirillen

commit 3a4d95c
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Jul 4 13:44:50 2021 +0200

    Added Power(less)shell to the title for know Windows issues...

    Signed by @spirillen

commit d9006c7
Author: Spirillen <pdns@protonmail.com>
Date:   Sun Jul 4 13:21:40 2021 +0200

    Knowen Issue Cygwin

    Have made some notes about the limitation of running Cygwin or Python on a Windows and how it is affecting @PyFunceble

    Signed by @spirillen
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: ScannerError

3 participants