From 2b45213876b8db2eca07aec936c5aa87fda61828 Mon Sep 17 00:00:00 2001 From: Fabio Erculiani Date: Wed, 8 Jul 2009 09:50:25 +0200 Subject: [PATCH] [docs] update API documentation --- docs/entropy/api/docs/class-tree.html | 23 +- docs/entropy/api/docs/entropy-module.html | 2 +- docs/entropy/api/docs/entropy-pysrc.html | 2 +- .../api/docs/entropy.cache-module.html | 2 +- .../entropy/api/docs/entropy.cache-pysrc.html | 2 +- .../entropy.cache.EntropyCacher-class.html | 2 +- .../api/docs/entropy.client-module.html | 2 +- .../api/docs/entropy.client-pysrc.html | 2 +- .../entropy.client.interfaces-module.html | 2 +- .../docs/entropy.client.interfaces-pysrc.html | 2 +- ...ntropy.client.interfaces.cache-module.html | 2 +- ...entropy.client.interfaces.cache-pysrc.html | 2 +- ...ent.interfaces.cache.CacheMixin-class.html | 2 +- ...tropy.client.interfaces.client-module.html | 2 +- ...ntropy.client.interfaces.client-pysrc.html | 2 +- ...client.interfaces.client.Client-class.html | 220 ++++----- ...ient.ClientSystemSettingsPlugin-class.html | 2 +- .../entropy.client.interfaces.dep-module.html | 2 +- .../entropy.client.interfaces.dep-pysrc.html | 2 +- ...interfaces.dep.CalculatorsMixin-class.html | 2 +- ...ntropy.client.interfaces.fetch-module.html | 2 +- ...entropy.client.interfaces.fetch-pysrc.html | 2 +- ....interfaces.fetch.FetchersMixin-class.html | 2 +- ...ropy.client.interfaces.loaders-module.html | 2 +- ...tropy.client.interfaces.loaders-pysrc.html | 2 +- ...interfaces.loaders.LoadersMixin-class.html | 2 +- ...ropy.client.interfaces.methods-module.html | 2 +- ...tropy.client.interfaces.methods-pysrc.html | 2 +- ...t.interfaces.methods.MatchMixin-class.html | 2 +- ...nt.interfaces.methods.MiscMixin-class.html | 2 +- ...erfaces.methods.RepositoryMixin-class.html | 2 +- ...ropy.client.interfaces.package-module.html | 2 +- ...tropy.client.interfaces.package-pysrc.html | 2 +- ...ient.interfaces.package.Package-class.html | 2 +- .../entropy.client.interfaces.qa-module.html | 2 +- .../entropy.client.interfaces.qa-pysrc.html | 2 +- ...aces.qa.UGCErrorReportInterface-class.html | 2 +- ...y.client.interfaces.repository-module.html | 2 +- ...py.client.interfaces.repository-pysrc.html | 2 +- ...nterfaces.repository.Repository-class.html | 2 +- ...ropy.client.interfaces.trigger-module.html | 2 +- ...tropy.client.interfaces.trigger-pysrc.html | 2 +- ...ient.interfaces.trigger.Trigger-class.html | 2 +- ...rigger.Trigger.EntropyPySandbox-class.html | 2 +- ...rigger.Trigger.EntropyShSandbox-class.html | 2 +- .../docs/entropy.client.mirrors-module.html | 2 +- .../docs/entropy.client.mirrors-pysrc.html | 2 +- ....client.mirrors.StatusInterface-class.html | 2 +- .../api/docs/entropy.client.misc-module.html | 2 +- .../api/docs/entropy.client.misc-pysrc.html | 2 +- ...entropy.client.misc.FileUpdates-class.html | 2 +- .../docs/entropy.client.services-module.html | 2 +- .../docs/entropy.client.services-pysrc.html | 2 +- ...entropy.client.services.system-module.html | 2 +- .../entropy.client.services.system-pysrc.html | 2 +- ...lient.services.system.commands-module.html | 2 +- ...client.services.system.commands-pysrc.html | 2 +- ...services.system.commands.Client-class.html | 2 +- ...ices.system.commands.Repository-class.html | 2 +- ...ent.services.system.interfaces-module.html | 2 +- ...ient.services.system.interfaces-pysrc.html | 2 +- ...rvices.system.interfaces.Client-class.html | 2 +- ...client.services.system.methods-module.html | 2 +- ....client.services.system.methods-pysrc.html | 2 +- ...rvices.system.methods.BaseMixin-class.html | 2 +- ...vices.system.methods.Repository-class.html | 2 +- .../entropy.client.services.ugc-module.html | 2 +- .../entropy.client.services.ugc-pysrc.html | 2 +- ...y.client.services.ugc.commands-module.html | 2 +- ...py.client.services.ugc.commands-pysrc.html | 2 +- ...ient.services.ugc.commands.Base-class.html | 2 +- ...nt.services.ugc.commands.Client-class.html | 2 +- ...client.services.ugc.interfaces-module.html | 2 +- ....client.services.ugc.interfaces-pysrc.html | 2 +- ...rvices.ugc.interfaces.AuthStore-class.html | 2 +- ...t.services.ugc.interfaces.Cache-class.html | 2 +- ....services.ugc.interfaces.Client-class.html | 2 +- .../api/docs/entropy.const-module.html | 2 +- .../entropy/api/docs/entropy.const-pysrc.html | 2 +- .../entropy/api/docs/entropy.core-module.html | 2 +- docs/entropy/api/docs/entropy.core-pysrc.html | 2 +- .../docs/entropy.core.Singleton-class.html | 22 +- .../entropy.core.SystemSettings-class.html | 2 +- ...tropy.core.SystemSettingsPlugin-class.html | 18 +- docs/entropy/api/docs/entropy.db-module.html | 2 +- docs/entropy/api/docs/entropy.db-pysrc.html | 2 +- .../entropy.db.EntropyRepository-class.html | 2 +- ...opy.db.EntropyRepository.Schema-class.html | 2 +- .../entropy.db.LocalRepository-class.html | 2 +- ...tropy.db.LocalRepository.Schema-class.html | 2 +- ...tropy.db.ServerRepositoryStatus-class.html | 2 +- .../entropy/api/docs/entropy.dump-module.html | 2 +- docs/entropy/api/docs/entropy.dump-pysrc.html | 2 +- .../api/docs/entropy.exceptions-module.html | 2 +- .../api/docs/entropy.exceptions-pysrc.html | 2 +- ...exceptions.CacheCorruptionError-class.html | 2 +- ...ropy.exceptions.CommandNotFound-class.html | 2 +- ...ropy.exceptions.ConnectionError-class.html | 2 +- ...ropy.exceptions.CorruptionError-class.html | 2 +- ...py.exceptions.DirectoryNotFound-class.html | 2 +- ...opy.exceptions.EntropyException-class.html | 94 ++-- ...eptions.EntropyPackageException-class.html | 2 +- ...entropy.exceptions.FileNotFound-class.html | 2 +- .../entropy.exceptions.FtpError-class.html | 2 +- ...y.exceptions.IncorrectParameter-class.html | 2 +- ...tropy.exceptions.InterruptError-class.html | 2 +- .../entropy.exceptions.InvalidAtom-class.html | 2 +- .../entropy.exceptions.InvalidData-class.html | 2 +- ...ropy.exceptions.InvalidDataType-class.html | 2 +- ....exceptions.InvalidDependString-class.html | 2 +- ...ropy.exceptions.InvalidLocation-class.html | 14 +- ...py.exceptions.InvalidPackageSet-class.html | 2 +- ...exceptions.InvalidVersionString-class.html | 2 +- ...ropy.exceptions.LibraryNotFound-class.html | 2 +- ...opy.exceptions.MissingParameter-class.html | 2 +- ...py.exceptions.OnlineMirrorError-class.html | 2 +- ...xceptions.OperationNotPermitted-class.html | 2 +- .../entropy.exceptions.ParseError-class.html | 2 +- ...opy.exceptions.PermissionDenied-class.html | 2 +- .../entropy.exceptions.QueueError-class.html | 2 +- ...y.exceptions.ReadOnlyFileSystem-class.html | 2 +- ...ropy.exceptions.RepositoryError-class.html | 2 +- .../entropy.exceptions.SPMError-class.html | 2 +- .../entropy.exceptions.SSLError-class.html | 2 +- ...py.exceptions.SecurityViolation-class.html | 2 +- ....exceptions.SystemDatabaseError-class.html | 2 +- .../entropy/api/docs/entropy.i18n-module.html | 2 +- docs/entropy/api/docs/entropy.i18n-pysrc.html | 2 +- .../entropy/api/docs/entropy.misc-module.html | 11 +- docs/entropy/api/docs/entropy.misc-pysrc.html | 462 +++++++++++------- .../api/docs/entropy.misc.Callable-class.html | 45 +- .../docs/entropy.misc.EmailSender-class.html | 2 +- .../docs/entropy.misc.EntropyGeoIP-class.html | 2 +- .../api/docs/entropy.misc.Lifo-class.html | 2 +- .../api/docs/entropy.misc.LogFile-class.html | 434 ++++++++++++++-- ...tropy.misc.MultipartPostHandler-class.html | 85 +++- .../docs/entropy.misc.ParallelTask-class.html | 2 +- .../api/docs/entropy.misc.RSS-class.html | 2 +- .../entropy.misc.TimeScheduled-class.html | 2 +- .../api/docs/entropy.output-module.html | 2 +- .../api/docs/entropy.output-pysrc.html | 2 +- .../entropy.output.TextInterface-class.html | 2 +- docs/entropy/api/docs/entropy.qa-module.html | 2 +- docs/entropy/api/docs/entropy.qa-pysrc.html | 2 +- ...entropy.qa.ErrorReportInterface-class.html | 2 +- .../docs/entropy.qa.QAInterface-class.html | 2 +- .../api/docs/entropy.security-module.html | 2 +- .../api/docs/entropy.security-pysrc.html | 2 +- ...ropy.security.SecurityInterface-class.html | 2 +- .../api/docs/entropy.server-module.html | 2 +- .../api/docs/entropy.server-pysrc.html | 2 +- .../entropy.server.interfaces-module.html | 2 +- .../docs/entropy.server.interfaces-pysrc.html | 2 +- ...entropy.server.interfaces.main-module.html | 2 +- .../entropy.server.interfaces.main-pysrc.html | 2 +- ...y.server.interfaces.main.Server-class.html | 2 +- ...verFatscopeSystemSettingsPlugin-class.html | 2 +- ...main.ServerSystemSettingsPlugin-class.html | 2 +- ...ropy.server.interfaces.mirrors-module.html | 2 +- ...tropy.server.interfaces.mirrors-pysrc.html | 2 +- ...erver.interfaces.mirrors.Server-class.html | 2 +- .../api/docs/entropy.services-module.html | 2 +- .../api/docs/entropy.services-pysrc.html | 2 +- ...tropy.services.auth_interfaces-module.html | 2 +- ...ntropy.services.auth_interfaces-pysrc.html | 2 +- ...ices.auth_interfaces.phpBB3Auth-class.html | 2 +- ...ntropy.services.authenticators-module.html | 2 +- ...entropy.services.authenticators-pysrc.html | 2 +- ....services.authenticators.phpBB3-class.html | 98 ++-- .../entropy.services.commands-module.html | 2 +- .../docs/entropy.services.commands-pysrc.html | 2 +- ...ntropy.services.commands.phpBB3-class.html | 2 +- .../entropy.services.interfaces-module.html | 2 +- .../entropy.services.interfaces-pysrc.html | 2 +- ....services.interfaces.SocketHost-class.html | 2 +- ...ocketHost.BasicPamAuthenticator-class.html | 2 +- ...aces.SocketHost.BuiltInCommands-class.html | 2 +- ...ces.SocketHost.CommandProcessor-class.html | 2 +- ...aces.SocketHost.HostServerMixin-class.html | 8 +- ...ost.HostServerMixin.ConnWrapper-class.html | 2 +- ...faces.SocketHost.RequestHandler-class.html | 2 +- .../entropy.services.repository-module.html | 2 +- .../entropy.services.repository-pysrc.html | 2 +- ...y.services.repository.commands-module.html | 2 +- ...py.services.repository.commands-pysrc.html | 2 +- ....repository.commands.Repository-class.html | 2 +- ...services.repository.interfaces-module.html | 2 +- ....services.repository.interfaces-pysrc.html | 2 +- ...es.repository.interfaces.Server-class.html | 2 +- ...erfaces.Server.ServiceInterface-class.html | 2 +- .../docs/entropy.services.skel-module.html | 2 +- .../api/docs/entropy.services.skel-pysrc.html | 2 +- ...opy.services.skel.Authenticator-class.html | 2 +- ...py.services.skel.RemoteDatabase-class.html | 2 +- ...rvices.skel.SocketAuthenticator-class.html | 2 +- ...py.services.skel.SocketCommands-class.html | 20 +- .../docs/entropy.services.system-module.html | 2 +- .../docs/entropy.services.system-pysrc.html | 2 +- ...tropy.services.system.commands-module.html | 2 +- ...ntropy.services.system.commands-pysrc.html | 2 +- ...y.services.system.commands.Base-class.html | 2 +- ...ices.system.commands.Repository-class.html | 2 +- ...ropy.services.system.executors-module.html | 2 +- ...tropy.services.system.executors-pysrc.html | 2 +- ....services.system.executors.Base-class.html | 2 +- ...opy.services.system.interfaces-module.html | 2 +- ...ropy.services.system.interfaces-pysrc.html | 2 +- ...rvices.system.interfaces.Server-class.html | 2 +- ...InSystemManagerExecutorCommands-class.html | 2 +- ...ces.Server.FakeServiceInterface-class.html | 2 +- ....system.interfaces.TaskExecutor-class.html | 2 +- .../api/docs/entropy.services.ugc-module.html | 2 +- .../api/docs/entropy.services.ugc-pysrc.html | 2 +- .../entropy.services.ugc.commands-module.html | 2 +- .../entropy.services.ugc.commands-pysrc.html | 2 +- ...tropy.services.ugc.commands.UGC-class.html | 2 +- ...ntropy.services.ugc.interfaces-module.html | 2 +- ...entropy.services.ugc.interfaces-pysrc.html | 2 +- ....services.ugc.interfaces.Client-class.html | 2 +- ....services.ugc.interfaces.Server-class.html | 2 +- docs/entropy/api/docs/entropy.spm-module.html | 2 +- docs/entropy/api/docs/entropy.spm-pysrc.html | 2 +- .../docs/entropy.spm.PortagePlugin-class.html | 2 +- ...m.PortagePlugin.paren_normalize-class.html | 2 +- .../api/docs/entropy.spm.Spm-class.html | 2 +- .../api/docs/entropy.tools-module.html | 2 +- .../entropy/api/docs/entropy.tools-pysrc.html | 2 +- .../api/docs/entropy.transceivers-module.html | 2 +- .../api/docs/entropy.transceivers-pysrc.html | 2 +- ...tropy.transceivers.FtpInterface-class.html | 2 +- ...y.transceivers.FtpServerHandler-class.html | 2 +- ...transceivers.MultipleUrlFetcher-class.html | 2 +- ...entropy.transceivers.UrlFetcher-class.html | 2 +- .../entropy/api/docs/entropy.xpak-module.html | 2 +- docs/entropy/api/docs/entropy.xpak-pysrc.html | 2 +- .../api/docs/entropy.xpak.tbz2-class.html | 2 +- docs/entropy/api/docs/help.html | 2 +- docs/entropy/api/docs/identifier-index.html | 2 +- docs/entropy/api/docs/index.html | 2 +- docs/entropy/api/docs/module-tree.html | 2 +- .../uml_class_diagram_for_entropy__20.gif | Bin 12798 -> 12704 bytes .../uml_class_diagram_for_entropy__22.gif | Bin 10872 -> 10937 bytes .../docs/uml_class_diagram_for_entropy__3.gif | Bin 131236 -> 128610 bytes .../uml_class_diagram_for_entropy__31.gif | Bin 54300 -> 52761 bytes .../uml_class_diagram_for_entropy__66.gif | Bin 35827 -> 36071 bytes .../uml_class_diagram_for_entropy__79.gif | Bin 14415 -> 14403 bytes 246 files changed, 1304 insertions(+), 702 deletions(-) diff --git a/docs/entropy/api/docs/class-tree.html b/docs/entropy/api/docs/class-tree.html index f9c074e40..9c4f89b6a 100644 --- a/docs/entropy/api/docs/class-tree.html +++ b/docs/entropy/api/docs/class-tree.html @@ -64,8 +64,6 @@ -
  • entropy.services.system.executors.Base -
  • entropy.client.services.ugc.commands.Base
  • +
  • entropy.services.system.executors.Base +
  • urllib2.BaseHandler
  • @@ -125,14 +126,15 @@ -
  • entropy.misc.Callable +
  • entropy.misc.Callable: + Fake class wrapping any callable object into a callable class.
  • entropy.client.services.ugc.interfaces.Client
  • -
  • entropy.client.services.system.interfaces.Client -
  • entropy.services.ugc.interfaces.Client
  • +
  • entropy.client.services.system.interfaces.Client +
  • entropy.services.interfaces.SocketHost.CommandProcessor
  • entropy.services.interfaces.SocketHost.HostServerMixin.ConnWrapper: @@ -189,7 +191,8 @@ Content (UGC) infrastructure.
  • -
  • entropy.misc.LogFile +
  • entropy.misc.LogFile: + Entropy simple logging interface, works as file object
  • entropy.client.interfaces.methods.MatchMixin
  • -
  • entropy.db.EntropyRepository.Schema -
  • entropy.db.LocalRepository.Schema
  • +
  • entropy.db.EntropyRepository.Schema +
  • entropy.security.SecurityInterface: ~~ GIVES YOU WINGS ~~
  • @@ -512,7 +515,7 @@ Content (UGC) infrastructure.