summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* libtracker-control: Add convenience API for IndexFileForProcessDebarshi Ray2016-08-231-0/+3
| | | | | | This mirrors the miner D-Bus API that is already available. https://bugzilla.gnome.org/show_bug.cgi?id=757369
* libtracker-sparql: Make tracker URI GType privateCarlos Garnacho2016-07-171-1/+3
| | | | | We don't expose it anywhere in API, may be hidden as an implementation detail.
* libtracker-sparql: Add TrackerResource/NamespaceManager to docsCarlos Garnacho2016-07-163-1/+64
| | | | And document the missing functions.
* Use TrackerResource instead of TrackerSparqlBuilder in all extractorswip/sam/resource-rebase-6Sam Thursfield2016-07-141-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For a long time, all the Tracker extractors have manually constructed a SPARQL update command using TrackerSparqlBuilder to represent their output. This commit changes all of them to use the TrackerResource class instead, which makes the code a lot more concise and readable. This introduces some API breaks in the internal libtracker-extract library. This has been a private library since Tracker 0.16 or earlier, so it's fine. If the extractors only output SPARQL then they are only useful to people who are using a SPARQL store. Now we can output a serialization format like Turtle as well. This will hopefully make the extract modules useful outside of Tracker itself. I've tried to preserve the behaviour of the extractors as much as possible, but there are two things that are now handled differently: * nao:Tag resources are given a fixed URI based on the tag label, such as <urn:tag:My_Tag>. Previously they were inserted as blank nodes, so tracker-store would give them unique IDs like <urn:uuid:1234...> * All extractors created nco:Contact resources for content publishers, but previously some would assign fixed URIs based on the name <urn:contact:James%20Joyce>, while others would insert them as blank nodes so they would be assigned unique IDs like <urn:uuid:1234...>. Now, all extractors create nco:Contact resources with fixed URIs based on the content creator's name. https://bugzilla.gnome.org/show_bug.cgi?id=767472
* Clarify SPARQL example in manpageSam Thursfield2016-07-141-2/+2
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=767246
* cli: Add --verbosity option to `tracker extract`wip/sam/extract-commandSam Thursfield2016-06-091-0/+48
| | | | | | | | This is based on the --set-log-verbosity option from `tracker daemon`. The TRACKER_VERBOSITY environment variable also works here, and overrides the value on the commandline, so I'm not sure if this patch is really necessary...
* Rewrite tracker-extract man pageSam Thursfield2016-06-091-49/+12
| | | | | It now corresponds with the user-facing `tracker-extract` command, rather than the hidden /usr/libexec/tracker-extract program.
* docs: Do not delete xml directory when redoing docsCarlos Garnacho2016-05-281-1/+1
| | | | | | | | | | | | We're competing with gtk-doc.make here, which may turn out in failures when doing mkdir on an already created directory, or failures in writing xml/gtkdocentities.ent because we deleted the directory under its feet. So just do the same, use MKDIR_P to ensure it won't fail if the directory is already there, and don't bother deleting it as it's handled in gtk-doc.make. The ontology docs helper app will rewrite the xml files anyway.
* tracker: Add -f argument to "tracker reset" CLI subcommandCarlos Garnacho2016-05-281-5/+7
| | | | | | It takes a file to be reset, works recursively for directories. Immediately after reset, a reindex will be requested, so the data is promptly indexed again.
* manpages: Drop manpages of configuration settings/filesCarlos Garnacho2016-05-142-56/+1
| | | | | | Gsettings are self-documenting, plus translatable. There is no need to duplicate this documentation, and even less if it focuses on the deprecated keyfile format. It is time to hide that under the rug.
* docs: Fix less-than-zero comparison of an unsigned valueHaithem BEN GHORBAL2016-02-141-1/+1
|
* tracker-sparql.1: Man page syntax fixVille Skyttä2015-07-061-1/+1
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=751723
* docs: Spelling fixesVille Skyttä2015-07-065-8/+8
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=751724
* docs: Ensure ontology properties can be looked up through devhelpCarlos Garnacho2015-07-041-1/+3
| | | | | The devhelp index generation relies on specific roles set in the docbook XML, we were setting none for ontology properties though.
* docs: delete xml folder before regenerating ontology docsCarlos Garnacho2015-07-011-1/+1
| | | | Otherwise it simply fails if there happens to be stale data
* update docs .gitignoreCarlos Garnacho2015-06-302-3/+1
|
* docs: Delete dia diagrams, and pre-generated PNGsCarlos Garnacho2015-06-3017-20/+0
| | | | | | Those weren't that much clear nor useful, those are deleted in a separate commit in case we want to rescue and rework them someday.
* docs: Delete ontology graph toolCarlos Garnacho2015-06-304-709/+1
| | | | | This is now unused, so remove the tool, and the configure.ac check for fdp.
* docs: Rework ontology docs generation entirelyCarlos Garnacho2015-06-3016-408/+1024
| | | | | | | | | | | | | | | | | | | | | | | | | Ontology docs weren't in a much good shape, besides many ontologies being seriously underdocumented (something which should improve separately), the generated docs were little more than a data dump, and the diagrams shown were broken, confusing, or both. This all amounts to quite counter-productive developer docs. So the ontology docs have been refurbished, the per-ontology descriptions are still useful, but have been stripped of all images, and the docs overall are now completely class-centric, per rdfs:Resource subclass we now get: - Ascii diagram of its local hierarchy, up to all its ancestors and down to all its direct children. - All properties that affect the specific class. This is notably more intuitive now as there's properties defined on one ontology that are in the domain of classes in another ontology, something which you couldn't get at a glance in the previous docs - It clearly states which properties supersede which superproperties, which again makes it easier if those apply for the class at hand. The result feels quite neater, and will indeed be more resembling to other gtk-doc generated API docs.
* Distcheck fixesCarlos Garnacho2015-03-171-1/+1
|
* libtracker-miner: Document missing APIsMartyn Russell2014-12-112-7/+2
|
* tracker: Merged utils/tracker-sql/tracker-sql into 'tracker sql ...'Martyn Russell2014-12-103-0/+50
|
* tracker: Merged all external commands into 'tracker'Martyn Russell2014-12-1011-401/+475
|
* tracker: Merge tracker-control into a 'tracker' commandMartyn Russell2014-12-108-88/+80
|
* libtracker-common: Moved tracker-ontologies.h into libtracker-sparqlMartyn Russell2014-10-271-19/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | The Namespace has been cleaned up too, all APIs now start with: TRACKER_PREFIX_ or TRACKER_DATASOURCE_ The well known definition for the TrackerMinerFS graph has also been changed to: TRACKER_OWN_GRAPH_URN because it now applies to more than just the TrackerMinerFS, we're using it in: tracker-writeback tracker-miner-apps tracker-miner-user-guides ... libtracker-data It should probably be internal actually.
* all: Migrate to GKeyfileSettingsBackend and generate man pages from schemasMartyn Russell2014-10-272-1/+56
| | | | | | | | | | | | | | | | | | Now we've removed the internal key file object, we've had to put in place another method for supporting the existing TRACKER_USE_CONFIG_FILES environment variable. Thanks to the GKeyfileSettingsBackend provided by GLib, we can fallback to old school INI type config files for embedded solutions or cases where we don't want dconf as a backend. This works rather well. IT should be noted, the INI files are *NOT* written out in full if they do not exist, only options which are saved or different to the default settings are. This is how it should be too. Now we build man pages based on GSettings schemas using xsltproc with the template in docs/manpages/gsettings.xsl. This is a useful aid when trying to understand what config files can have in them. One thing it does highlight, is the config documentation could be better :)
* data: Moved ontologies/ into src/Martyn Russell2014-09-263-4/+4
|
* libtracker-miner: Fix API break with tracker_indexing_tree_new()Rico Tzschichholz2014-09-251-0/+1
| | | | | | | Previously it took void and it was changed to take a GFile. https://bugzilla.gnome.org/show_bug.cgi?id=737243 (cherry picked from commit 8c6485a312ffbd1c9bb3c95d5933284f56990045)
* libtracker-miner: Removed APIs that were never released as stable APIMartyn Russell2014-09-221-5/+0
|
* tracker-stats: Change default behaviour and add new command line optionsMartyn Russell2014-09-031-6/+24
| | | | | | | | | | | | Now we only show common RDF types by default, e.g. nfo:Document and it is based on .rules file fallback types and some others specifically added. There is also now a --all option to return all stats as was the behaviour before. In addition to this, the EXPRESSIONS provided on the command line following the OPTIONS can be used to filter the stats, e.g. : 'tracker-stats doC' will list the nfo:Document class and resources in the DB matching.
* libtracker-miner: Add tracker_decorator_fs_prepend_file()Carlos Garnacho2014-08-131-0/+1
| | | | | This is a convenience function that retrieves the tracker:id for the file nie:url and prepends it for processing.
* libtracker-miner: Split TrackerEnumerator into 2 classes, now with ↵Martyn Russell2014-08-122-136/+187
| | | | | | | | | | TrackerDataProvider So now we have: - TrackerEnumerator (GInterface) - TrackerFileEnumerator (using GIO API) - TrackerDataProvider (GInterface) which provides a TrackerEnumerator - TrackerFileDataProvider (using GIO API) implemented as internal default
* libtracker-control: Allow miner status to be gained from running processesMartyn Russell2014-08-121-0/+16
| | | | Using environment variable: TRACKER_MINERS_DIR_DISABLED
* libtracker-miner: Added tracker_indexing_tree_get_master_root() and set in ↵Martyn Russell2014-08-121-0/+1
| | | | | | | | | constructed() This function gets the top level root for all roots, e.g. file:/// We also create the root nodes in constructed() not init() because then the root GFile has been set in the properties when the object is initiated
* libtracker-miner: Document TRACKER_MINER_DBUS_* definesMartyn Russell2014-08-121-0/+3
|
* libtracker-miner: Move TRACKER_MINER_DBUS_* definitions to ↵Martyn Russell2014-08-121-1/+0
| | | | | | | tracker-miner-object.h There is no need for these to be in a separate header and also they're useful for other miners
* libtracker-miner: Added MinerFS _get_enumerator() functionMartyn Russell2014-08-121-0/+1
|
* libtracker-miner: Update all documentation around TrackerEnumerator interfaceMartyn Russell2014-08-122-1/+35
| | | | | | | Including: - How we use it in TrackerMinerFS - TrackerEnumerator itself - TrackerFileEnumerator
* libtracker-miner: Added MinerFSError quark for GErrors returnedMartyn Russell2014-08-121-0/+2
|
* libtracker-control: Added missing sections.txt for documentationMartyn Russell2014-07-211-0/+35
|
* docs/reference: Use FULL paths for DOC_SOURCE_DIR to avoid undefined warningsMartyn Russell2014-07-103-3/+3
| | | | | This only occurs during distcheck because the path is not relative any more, but it should be referenced from $(top_srcdir) anyway to avoid these warnings.
* tracker-info: Add --resource-is-uri | -i to avoid filename -> urn lookupsMartyn Russell2014-06-271-0/+14
|
* tracker-control: Added --watch command line option to watch changes to DBMartyn Russell2014-04-231-0/+30
| | | | | This allows people to see updates in real time to the database for files and any of the properties related to those.
* tracker-control: Remove shorthand options for less used switchesMartyn Russell2014-04-231-4/+4
|
* Merge branch 'tracker-tag-and-operator-fix'Martyn Russell2014-03-251-5/+16
|\
| * tracker-tag: Replace --or-operator with --and-operator for --list optionMartyn Russell2014-03-201-5/+16
| | | | | | | | | | | | | | | | | | | | Currently all arguments supplied for --list are handled with an OR condition, making the existing --or-operator redundant. This makes --and-operator useful for querying for files matching 1 or more tag labels. https://bugzilla.gnome.org/show_bug.cgi?id=725717
* | Merge branch 'make-decorator-errors-public'Martyn Russell2014-03-211-0/+2
|\ \
| * | libtracker-miner, tracker-extract: Don't g_warning() on decorator items we ↵Martyn Russell2014-03-211-0/+2
| |/ | | | | | | | | | | | | | | don't process In normal circumstances, we may get TRACKER_DECORATOR_ERROR_{EMPTY|PAUSED}, but tracker-extract issues a g_warning(). We want to avoid using a warning for these warnings because they're normal and expected operations.
* | docs: minor tracker-store man page cleanupDominique Brazziel2014-03-211-1/+3
|/ | | | https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=675198
* tracker-extract: Removed support for libstreamanalyzerMartyn Russell2014-03-181-4/+0
| | | | | | | This has not been compiled or used in years and likely doesn't produce an ontology compatible output that we could use. EXTERMINATE!