[gentoo-soc] [Report 8] layman improvements

[gentoo-soc] [Report 8] layman improvements

[Devan Franchini]

Hello everyone,

This week the following progress has been made:

1.) Centralization of archive overlay type code:
     - Due to most archive overlay types being so
       similar, I centralized the majority of the code
       in order to allow all archive overlay types to
       subclass from one main ArchiveOverlay class,
       allowing for easier maintainability.

 2.) Multiple description field support:
      - https://bugs.gentoo.org/465730 discusses
        the fact that layman does not support multiple
        description fields, but could possibly need to.
      - The support has been added but isn't complete
         because the current method doesn't take into
        account the lang attribute of the description tag,
         this will be addressed.

3.) Changes to the overlay-maker class:
     - github.com and git.overlays.gentoo.org https://
       source URLs are now supported in the overlay
       creation.
     - On a successful write the user will be notified of
       write path of the overlay.xml file.

4.) An Interactive session has been added for unofficial
     overlay installs:
     - A configurable feature has been added to notify the
       user if they are installing an overlay that is not official.

5,) CLI improvements:
     - The --setup_help flag has been renamed to --setup-help
     - Support for multiple arguments to one action flag has been
       added. Users can now perform actions as so:
       "layman -a <ovl 1> <ovl 2>..."

6.) Ability to disable or enable overlays:
     - If a user wants portage to ignore the ebuilds of a certain
       overlay without deleting the overlay they can simply run
       "layman -D <ovl>" to have the overlay disabled. They can
       then run "layman -E <ovl>" to re-enable that overlay so portage
       can find the ebuilds yet again.
     - This is currently only supported for make.conf. I hope to add
       repos.conf support eventually.

7.) Small improvements have been made to layman's codebase:
     - layman will now take into account if the user is using more than
       one repo configuration method when handling the success or failure.
       This will prevent layman reporting False negatives.
     - layman will now correctly inform a user if an overlay is supported when
       running "layman -v -i <ovl>".

Goals for next week:
~~~~~~~~~~~~~~~
* Begin working on a two week long quest to migrate the docstring tests to a
  full test suite.

I apologize for the long progress report. :)


As always, to anyone interested the source code and my commits can be
found on git.overlays.gentoo.org/gitweb/[1] or on github.com[2] on
layman's gsoc2014 branch.

  [1]http://git.overlays.gentoo.org/gitweb/?p=proj/layman.git;a=shortlog;h=refs/heads/gsoc2014
  [2]https://github.com/twitch153/layman/tree/gsoc2014

With regards,
    Devan Franchini (twitch153)