* \file acquire-item.h
*/
-/** \brief Represents the process by which a pkgAcquire object should
+/** \brief Represents the process by which a pkgAcquire object should {{{
* retrieve a file or a collection of files.
*
* By convention, Item subclasses should insert themselves into the
*/
virtual ~Item();
};
-
-/** \brief Information about an index patch (aka diff). */
+ /*}}}*/
+/** \brief Information about an index patch (aka diff). */ /*{{{*/
struct DiffInfo {
/** The filename of the diff. */
string file;
/** The size of the diff. */
unsigned long size;
};
-
-/** \brief An item that is responsible for fetching an index file of
+ /*}}}*/
+/** \brief An item that is responsible for fetching an index file of {{{
* package list diffs and starting the package list's download.
*
* This item downloads the Index file and parses it, then enqueues
pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
string ShortDesc, HashString ExpectedHash);
};
-
-/** \brief An item that is responsible for fetching all the patches
+ /*}}}*/
+/** \brief An item that is responsible for fetching all the patches {{{
* that need to be applied to a given package index file.
*
* After downloading and applying a single patch, this item will
string ShortDesc, HashString ExpectedHash,
vector<DiffInfo> diffs=vector<DiffInfo>());
};
-
-/** \brief An acquire item that is responsible for fetching an index
+ /*}}}*/
+/** \brief An acquire item that is responsible for fetching an index {{{
* file (e.g., Packages or Sources).
*
* \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans
*
* \param compressExt The compression-related extension with which
* this index file should be downloaded, or "" to autodetect
- * (".bz2" is used if bzip2 is installed, ".gz" otherwise).
+ * Compression types can be set with config Acquire::CompressionTypes,
+ * default is ".lzma" or ".bz2" (if the needed binaries are present)
+ * fallback is ".gz" or none.
*/
pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
string ShortDesc, HashString ExpectedHash,
string compressExt="");
};
-
-/** \brief An acquire item that is responsible for fetching a
+ /*}}}*/
+/** \brief An acquire item that is responsible for fetching a {{{
* translated index file.
*
* The only difference from pkgAcqIndex is that transient failures
* \param URIDesc A "URI-style" description of this index file.
*
* \param ShortDesc A brief description of this index file.
- *
- * \param ExpectedHash The expected hashsum of this index file.
- *
- * \param compressExt The compression-related extension with which
- * this index file should be downloaded, or "" to autodetect
- * (".bz2" is used if bzip2 is installed, ".gz" otherwise).
*/
pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
string ShortDesc);
};
-
-/** \brief Information about an index file. */
+ /*}}}*/
+/** \brief Information about an index file. */ /*{{{*/
struct IndexTarget
{
/** \brief A URI from which the index file can be downloaded. */
*/
string MetaKey;
};
-
-/** \brief An acquire item that downloads the detached signature
+ /*}}}*/
+/** \brief An acquire item that downloads the detached signature {{{
* of a meta-index (Release) file, then queues up the release
* file itself.
*
/** \brief The last good signature file */
string LastGoodSig;
-
/** \brief The fetch request that is currently being processed. */
pkgAcquire::ItemDesc Desc;
const vector<struct IndexTarget*>* IndexTargets,
indexRecords* MetaIndexParser);
};
-
-/** \brief An item that is responsible for downloading the meta-index
+ /*}}}*/
+/** \brief An item that is responsible for downloading the meta-index {{{
* file (i.e., Release) itself and verifying its signature.
*
* Once the download and verification are complete, the downloads of
const vector<struct IndexTarget*>* IndexTargets,
indexRecords* MetaIndexParser);
};
-
-/** \brief An item that is responsible for fetching a package file.
+ /*}}}*/
+/** \brief An item that is responsible for fetching a package file. {{{
*
* If the package file already exists in the cache, nothing will be
* done.
pkgRecords *Recs,pkgCache::VerIterator const &Version,
string &StoreFilename);
};
-
-/** \brief Retrieve an arbitrary file to the current directory.
+ /*}}}*/
+/** \brief Retrieve an arbitrary file to the current directory. {{{
*
* The file is retrieved even if it is accessed via a URL type that
* normally is a NOP, such as "file". If the download fails, the
string Desc, string ShortDesc,
const string &DestDir="", const string &DestFilename="");
};
-
+ /*}}}*/
/** @} */
#endif
projects / apt.git / blobdiff