Bug 907844 – Including an "adding eselect modules manually" to the eselect developer guide

• Product: Gentoo Hosted Projects
• Status: RESOLVED FIXED

[Description Lemon Lime 2023-06-04 14:30:06 UTC]

The eselect developer guide article (https://wiki.gentoo.org/wiki/Project:Eselect/Developer_guide) does not include a section on how to test an eselect module.

Ulm (https://wiki.gentoo.org/wiki/User:Ulm) pointed out that it is possible to include the eselect module on ~/.eselect/modules. This is not stated neither in the developer guide (https://wiki.gentoo.org/wiki/Project:Eselect/Developer_guide) nor in the User Guide (https://wiki.gentoo.org/wiki/Project:Eselect/User_guide)

I'd suggest adding a small section with something along the lines of:

== Adding eselect modules manually ==

 eselect modules can be added manually to a Gentoo system. This is specially useful when an eselect module is being developed and needs to be tested.
 Adding the eselect module to {{Path|~/.eselect/modules}} will make eselect aware of said module. <br>
 Tip: The module can be a symlink, this will avoid the need to copy and paste the module every time a change is made

[Comment 1 Lemon Lime 2023-06-04 14:33:10 UTC]

As a bonus: I would also include a small section on how to write a simple eselect ebuild.
I took a look at a couple of eselect ebuilds and I believe Ruby's to be a fairly simple ebuild to take notes from.

Maybe Ruby's eselect ebuild can be added as an example on the wiki page itself

[Comment 2 Ulrich Müller 2023-06-04 17:42:32 UTC]

Created attachment 863254 [details, diff]
Add subsection about module testing to developer guide

I've shortened the text a little, because the developer guide addresses developers and module authors, so I want to keep it concise.

Please review attached patch.

We would add this to 
https://gitweb.gentoo.org/proj/eselect.git/tree/doc/developer-guide.txt
from where the wiki page would be synced.

[Comment 3 Lemon Lime 2023-06-04 18:18:16 UTC]

Looks great! Thank you so much for all of your work!

[Comment 4 Larry the Git Cow 2023-06-04 18:39:09 UTC]

The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/proj/eselect.git/commit/?id=5f3a0c3cbf4c85b69a3937b792a37ae8d95d6b8a

commit 5f3a0c3cbf4c85b69a3937b792a37ae8d95d6b8a
Author:     Ulrich Müller <[e-mail]>
AuthorDate: 2023-06-04 17:35:26 +0000
Commit:     Ulrich Müller <[e-mail]>
CommitDate: 2023-06-04 17:35:26 +0000

    Add subsection about module testing to developer guide
    
    * doc/developer-guide.txt: Add subsection about module testing.
    Thanks to [e-mail] for the suggestion. Bug 907844.
    
    Original-author: Lemon Lime <[e-mail]>
    Closes: https://bugs.gentoo.org/907844
    Signed-off-by: Ulrich Müller <[e-mail]>

 ChangeLog               | 5 +++++
 doc/developer-guide.txt | 8 ++++++++
 2 files changed, 13 insertions(+)

[Comment 5 Larry the Git Cow 2023-06-06 18:54:53 UTC]

The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=a7c3c82dab37b4ebaee8fc9f110aa86264a15b4a

commit a7c3c82dab37b4ebaee8fc9f110aa86264a15b4a
Author:     Ulrich Müller <[e-mail]>
AuthorDate: 2023-06-06 18:51:58 +0000
Commit:     Ulrich Müller <[e-mail]>
CommitDate: 2023-06-06 18:54:47 +0000

    app-admin/eselect: add 1.4.23
    
    Closes: https://bugs.gentoo.org/905934
    Closes: https://bugs.gentoo.org/907844
    Signed-off-by: Ulrich Müller <[e-mail]>

 app-admin/eselect/Manifest              |  1 +
 app-admin/eselect/eselect-1.4.23.ebuild | 58 +++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)