Changes between Version 203 and Version 204 of SummerOfCode


Ignore:
Timestamp:
Mar 25, 2013, 8:51:56 AM (11 years ago)
Author:
larryv (Lawrence Velázquez)
Comment:

break lines for better diffs

Legend:

Unmodified
Added
Removed
Modified
  • SummerOfCode

    v203 v204  
    3939The official [http://www.google-melange.com/gsoc/events/google/gsoc2013 timeline] should be consulted for the other dates.
    4040
    41 There are several things to consider. We are willing to support and mentor students who want to gain an experience by working on the MacPorts Project. We have many ideas for potential internship subjects, yet we are open to anything that is both interesting and relevant to MacPorts. Motivated students do not necessarily need to know Tcl language beforehand, especially if they already know several scripting languages such as Python, Ruby, PHP or Perl.
     41There are several things to consider. We are willing to support and
     42mentor students who want to gain an experience by working on the
     43MacPorts Project. We have many ideas for potential internship subjects,
     44yet we are open to anything that is both interesting and relevant to
     45MacPorts. Motivated students do not necessarily need to know Tcl
     46language beforehand, especially if they already know several scripting
     47languages such as Python, Ruby, PHP or Perl.
    4248
    4349=== For the MacPorts Project ===
    4450
    45 The best way to apply is to first make contact with us, either by sending a mail to the MacPorts developer [http://lists.macosforge.org/mailman/listinfo/macports-dev "mailing list"], to the potential mentors listed below, or to IRC members on #macports on [http://freenode.net/ FreeNode].
     51The best way to apply is to first make contact with us, either by
     52sending a mail to the MacPorts developer
     53[http://lists.macosforge.org/mailman/listinfo/macports-dev "mailing list"],
     54to the potential mentors listed below, or to IRC members on #macports on
     55[http://freenode.net/ FreeNode].
    4656
    4757What we expect from students for their applications:
     
    6878== Tasks ==
    6979
    70 This is a list of some potential tasks that student GSoC members could undertake. These are just ideas, and while they express our current concerns, we are open to blue-sky projects related to MacPorts.
    71 
    72 Please note that this list is absolutely '''not exclusive'''! If you have any idea about what you want to see improved in MacPorts, you are free to propose this as your own project. In any case, we recommend you talk to mentors before writing your application.
     80This is a list of some potential tasks that student GSoC members could
     81undertake. These are just ideas, and while they express our current
     82concerns, we are open to blue-sky projects related to MacPorts.
     83
     84Please note that this list is absolutely '''not exclusive'''! If you
     85have any idea about what you want to see improved in MacPorts, you are
     86free to propose this as your own project. In any case, we recommend you
     87talk to mentors before writing your application.
    7388
    7489=== Core tasks ===
     
    7691==== Binaries ==== #binaries
    7792
    78 MacPorts provides binaries but needs several enhancements. This task would include updating the chroot mechanism (ceased being functional with Snow Leopard) and adding support for variants. (See also [[MPAB|MacPorts AutoBuild]].)
     93MacPorts provides binaries but needs several enhancements. This task
     94would include updating the chroot mechanism (ceased being functional
     95with Snow Leopard) and adding support for variants. (See also
     96[[MPAB|MacPorts AutoBuild]].)
    7997
    8098* Difficulty: Relatively challenging to challenging
     
    84102==== Dependency calculation using SAT solving ==== #dependencies
    85103
    86 This task consists of implementing a new dependency engine for MacPorts. The current dependency engine properly deals with installing packages, but it does not deal satisfactorily with [[ticket:126|dependencies on variants]] and versions, uninstalling and upgrading. This task requires understanding the dependency relations (required for fetching, building, configuring; static and dynamic linking; dependence at runtime).
    87 
    88 Instead of re-inventing the wheel it might be helpful to use software available to solve the problem of dependency calculation, e.g. by implementing an interface to a [http://www.mancoosi.org/cudf/ Common Upgradeability Description Format]-based SAT solver. Such a solver could generate an execution plan we could propose to the user and finally execute when confirmed. For this task, the MacPorts concept of variants needs to be transformed into a representation the SAT solvers will be able to optimize. If time permits, rolling back on failed updates can also be implemented.
    89 There is also a [browser:trunk/dports/devel/libCUDF/Portfile libCUDF] port that might be helpful to look at.
     104This task consists of implementing a new dependency engine for MacPorts.
     105The current dependency engine properly deals with installing packages,
     106but it does not deal satisfactorily with [[ticket:126|dependencies on variants]]
     107and versions, uninstalling and upgrading. This task requires
     108understanding the dependency relations (required for fetching, building,
     109configuring; static and dynamic linking; dependence at runtime).
     110
     111Instead of re-inventing the wheel it might be helpful to use software
     112available to solve the problem of dependency calculation, e.g. by
     113implementing an interface to a
     114[http://www.mancoosi.org/cudf/ Common Upgradeability Description Format]-based
     115SAT solver. Such a solver could generate an execution plan we could
     116propose to the user and finally execute when confirmed. For this task,
     117the MacPorts concept of variants needs to be transformed into
     118a representation the SAT solvers will be able to optimize. If time
     119permits, rolling back on failed updates can also be implemented. There
     120is also a [browser:trunk/dports/devel/libCUDF/Portfile libCUDF] port
     121that might be helpful to look at.
    90122
    91123* Difficulty: Challenging
     
    95127==== Remove dependency on Xcode ==== #xcode
    96128
    97 MacPorts currently requires a full Xcode installation, even if the user only wishes to install prepackaged binaries or compile ports that do not use Xcode projects for building. This task be as simple as allowing MacPorts to install binary packages without Xcode present, or as complex as enabling MacPorts to be completely self-sufficient (not requiring Xcode or the Command Line Tools at all).
     129MacPorts currently requires a full Xcode installation, even if the user
     130only wishes to install prepackaged binaries or compile ports that do not
     131use Xcode projects for building. This task be as simple as allowing
     132MacPorts to install binary packages without Xcode present, or as complex
     133as enabling MacPorts to be completely self-sufficient (not requiring
     134Xcode or the Command Line Tools at all).
    98135
    99136* Difficulty: Medium to very challenging
     
    103140==== MacPorts port for self-management ==== #self-management
    104141
    105 The MacPorts port should be the source for updating a user’s MacPorts installation.
    106 
    107 Currently the MacPorts port is used to build the .dmg installer for MacPorts that is used for the initial installation of MacPorts, and port uses the “selfupdate” mechanism for maintaining the MacPorts installation. The selfupdate mechanism is (at least not documented as such) not accessible through the MacPorts API and does not use the MacPorts mechanisms for maintaining ports
     142The MacPorts port should be the source for updating a user’s MacPorts
     143installation.
     144
     145Currently the MacPorts port is used to build the .dmg installer for
     146MacPorts that is used for the initial installation of MacPorts, and port
     147uses the “selfupdate” mechanism for maintaining the MacPorts
     148installation. The selfupdate mechanism is (at least not documented as
     149such) not accessible through the MacPorts API and does not use the
     150MacPorts mechanisms for maintaining ports.
    108151
    109152* Difficulty: Challenging
     
    113156==== Perl modules integration from CPAN ==== #cpan2port
    114157
    115 There has been [[browser:contrib/cpan2port|an attempt]] to write a script for automatic generation of Portfiles from CPAN. This would simplify the maintenance of Perl modules in MacPorts. Revive this project and finish the script or rewrite it.
     158There has been [[browser:contrib/cpan2port|an attempt]] to write
     159a script for automatic generation of Portfiles from CPAN. This would
     160simplify the maintenance of Perl modules in MacPorts. Revive this
     161project and finish the script or rewrite it.
    116162
    117163Resources:
     
    126172==== Read packages from Python's PIP (pip2port) ==== #pip2port
    127173
    128 MacPorts should be able to more readily install python packages from pip. We don't want to integrate the build/installation process of PIP, simply parse information or eggs it provides for various packages. This information will then be used to generate a Portfile, akin to [[browser:contrib/cpan2port/cpan2port|cpan2port]].
    129 
    130 There may be instances where MacPorts package names don't match up with pip’s. In this case, pip should be the authority and all improperly named MacPorts packages should be replaced by a renamed copy. Verbose automation of this step, akin to the portcheckup script, is ideal.
    131 
    132 The [[browser:contrib/portfile-gen/portfile-gen|portfile generator]] might be helpful.
     174MacPorts should be able to more readily install python packages from
     175pip. We don't want to integrate the build/installation process of PIP,
     176simply parse information or eggs it provides for various packages. This
     177information will then be used to generate a Portfile, akin to
     178[[browser:contrib/cpan2port/cpan2port|cpan2port]].
     179
     180There may be instances where MacPorts package names don't match up with
     181pip’s. In this case, pip should be the authority and all improperly
     182named MacPorts packages should be replaced by a renamed copy. Verbose
     183automation of this step, akin to the portcheckup script, is ideal.
     184
     185The [[browser:contrib/portfile-gen/portfile-gen|portfile generator]]
     186might be helpful.
    133187
    134188* Difficulty: Medium
     
    138192==== Read packages from other various package managers ==== #foo2port
    139193
    140 As above with the pip2port proposal, except with other package managers, such as [http://opam.ocamlpro.com/ opam] for ocaml packages, [http://www.haskell.org/cabal/ cabal] for haskell, [http://luarocks.org/ luarocks] for lua, [https://npmjs.org/ npm] for node.js, and so on.
     194As above with the pip2port proposal, except with other package managers,
     195such as [http://opam.ocamlpro.com/ opam] for ocaml packages,
     196[http://www.haskell.org/cabal/ cabal] for haskell, [http://luarocks.org/ luarocks]
     197for lua, [https://npmjs.org/ npm] for node.js, and so on.
    141198
    142199* Classification: Medium
     
    146203==== Increase test coverage ==== #testing
    147204
    148 MacPorts currently includes a [[source:trunk/base/tests|test framework]] to test features of the infrastructure. However, the tests do not cover all the code. This task consists of extending the test framework and could be broadened to develop a code coverage technology for MacPorts to make the infrastructure more robust to future changes.
     205MacPorts currently includes a [[source:trunk/base/tests|test framework]]
     206to test features of the infrastructure. However, the tests do not cover
     207all the code. This task consists of extending the test framework and
     208could be broadened to develop a code coverage technology for MacPorts to
     209make the infrastructure more robust to future changes.
    149210
    150211* Difficulty: Relatively easy to very challenging
     
    154215==== Configuration and environment selftest ==== #envcheck
    155216
    156 Add a command to check current setup for common pitfalls (e.g. stuff in `/usr/local`), inspired by Homebrew’s `brew doctor` functionality.
     217Add a command to check current setup for common pitfalls (e.g. stuff in
     218`/usr/local`), inspired by Homebrew’s `brew doctor` functionality.
    157219
    158220* Difficulty: Easy
     
    162224==== Improve Trace mode ==== #tracemode
    163225
    164 Improve trace mode to the point where developers (and the build server) could run with it always turned on. This currently requires fixing some (minor) remaining bugs in the trace code itself, adjust the build system to always build the tracing library as universal binary and improving the Tcl backend of trace mode (e.g. by adding more features like a list of accessed files, speeding up the lookup by using better data structures).
     226Improve trace mode to the point where developers (and the build server)
     227could run with it always turned on. This currently requires fixing some
     228(minor) remaining bugs in the trace code itself, adjust the build system
     229to always build the tracing library as universal binary and improving
     230the Tcl backend of trace mode (e.g. by adding more features like a list
     231of accessed files, speeding up the lookup by using better data
     232structures).
    165233
    166234* Difficulty: Medium to Easy
     
    170238==== Improve startupitem code ==== #startupitem
    171239
    172 MacPorts has the ability to automatically generate startup items for the current platform. For OS X, these are plist files for launchd which will be installed as `/Library/LaunchDaemons/org.macports.*.plist`. The current code would need a little care and could make use of options which have been added in recent releases of launchd.
     240MacPorts has the ability to automatically generate startup items for the
     241current platform. For OS X, these are plist files for launchd which will
     242be installed as `/Library/LaunchDaemons/org.macports.*.plist`. The
     243current code would need a little care and could make use of options
     244which have been added in recent releases of launchd.
    173245
    174246Features that could be useful include (but are not limited to):
     
    185257==== Reclaim disk space ==== #reclaim
    186258
    187 Improve `port clean` to be able to delete distfiles for a specified version, and all distfiles not needed by currently installed versions of ports. In general, add an action for reclaiming disk space, which would delete old distfiles and archives and uninstall inactive ports (and anything else that would help)
     259Improve `port clean` to be able to delete distfiles for a specified
     260version, and all distfiles not needed by currently installed versions of
     261ports. In general, add an action for reclaiming disk space, which would
     262delete old distfiles and archives and uninstall inactive ports (and
     263anything else that would help).
    188264
    189265* Difficulty: Easy
     
    193269==== Parallel execution ==== #parallel
    194270
    195 When an action will run targets on multiple ports, run them in parallel when possible and sensible (requires tracking dependencies between both targets and ports and figuring out the maximum reasonable parallelism, e.g. several ports can fetch at once on a fast connection but you only want one 'make -j8' at a time)
     271When an action will run targets on multiple ports, run them in parallel
     272when possible and sensible (requires tracking dependencies between both
     273targets and ports and figuring out the maximum reasonable parallelism,
     274e.g. several ports can fetch at once on a fast connection but you only
     275want one 'make -j8' at a time).
    196276
    197277* Difficulty: Very challenging
     
    201281==== Migrate muniversal into base (lipo merging) ==== #muniversal
    202282
    203 Integrate the [[source:trunk/dports/_resources/port1.0/group/muniversal-1.0.tcl|muniversal portgroup]] into base. Not just a direct copy-and-paste, but in a way that makes sense and preserves the way portfiles are expected to behave (which the current portgroup doesn't).
     283Integrate the
     284[[source:trunk/dports/_resources/port1.0/group/muniversal-1.0.tcl|muniversal portgroup]]
     285into base. Not just a direct copy-and-paste, but in a way that makes
     286sense and preserves the way portfiles are expected to behave (which the
     287current portgroup doesn't).
    204288
    205289* Difficulty: Medium
     
    209293==== Improve fetching from version control ==== #fetchtypes
    210294
    211 Make cvs/svn/git/hg/bzr fetch types checkout into the distfiles dir and then export into the work dir, to [[ticket:16373|avoid having to re-fetch]] after cleaning the work dir.
     295Make cvs/svn/git/hg/bzr fetch types checkout into the distfiles dir and
     296then export into the work dir, to [[ticket:16373|avoid having to re-fetch]]
     297after cleaning the work directory.
    212298
    213299* Difficulty: Easy
     
    217303==== Interactive port command ==== #interactive
    218304
    219 Write an interactive command-line tool that can be used instead of the non-interactive port(1).
     305Write an interactive command-line tool that can be used instead of the
     306non-interactive port(1).
    220307
    221308The current port(1) should be viewed as batch mode reading from stdin.
    222309
    223 An interactive tool would ask for user input to resolve many situations that cause port(1) to simply error out. For example, if you try to install a port and one of its dependencies conflicts with something already installed, it could ask if you want to deactivate the installed one and its dependents.
     310An interactive tool would ask for user input to resolve many situations
     311that cause port(1) to simply error out. For example, if you try to
     312install a port and one of its dependencies conflicts with something
     313already installed, it could ask if you want to deactivate the installed
     314one and its dependents.
    224315
    225316* Difficulty: Medium
     
    232323==== Portfiles ==== #portfiles
    233324
    234 Sweep through all Portfiles and look for useful opportunities to add more built-in Tcl functions that make Portfiles more (usefully) terse, powerful, flexible or easier to write. I'm sure there is an entirely family of helper functions yet to be written here. This might also include porting additional packages to MacPorts and cleaning up or removing obsolete ports.
     325Sweep through all Portfiles and look for useful opportunities to add
     326more built-in Tcl functions that make Portfiles more (usefully) terse,
     327powerful, flexible or easier to write. I'm sure there is an entirely
     328family of helper functions yet to be written here. This might also
     329include porting additional packages to MacPorts and cleaning up or
     330removing obsolete ports.
    235331
    236332* Classification: Medium
     
    240336==== Documentation and website ==== #docs
    241337
    242 Improve MacPorts [query:status!=closed&component=guide|server/hosting|website|wiki documentation, website and Trac system]. Note that pure documentation proposals are not allowed by Google.
     338Improve MacPorts
     339[query:status!=closed&component=guide|server/hosting|website|wiki documentation, website and Trac system].
     340Note that pure documentation proposals are not allowed by Google.
    243341
    244342* Difficulty: Easy to difficult
     
    248346==== Shell environment ==== #shell-environment
    249347
    250 Add support for providing basic and port-provided environmental services to users in the `~/.profile`, `~/.cshrc`, and `~/.xinitrc` files, so that instead of manipulating the user's .profile to modify certain paths, the installer could append "`source /opt/local/etc/bash.rc`" to the end of a user's .profile file and that bash.rc would source all the files in `/opt/local/etc/bash.d`.
     348Add support for providing basic and port-provided environmental services
     349to users in the `~/.profile`, `~/.cshrc`, and `~/.xinitrc` files, so
     350that instead of manipulating the user's .profile to modify certain
     351paths, the installer could append "`source /opt/local/etc/bash.rc`" to
     352the end of a user's .profile file and that bash.rc would source all the
     353files in `/opt/local/etc/bash.d`.
    251354
    252355This task alone is most probably not enough for the whole Summer Of Code.