Skip to content

Commit

Permalink
Add fssync documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
shermp committed Apr 19, 2024
1 parent 75c12ed commit 5c8cabe
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions src/ndb/NDBDbus.cc
Original file line number Diff line number Diff line change
Expand Up @@ -716,16 +716,49 @@ void NDBDbus::pfmRescanBooksFull() {
return ndbNickelMisc("rescan_books_full");
}

/*!
* \brief Begins a filesystem sync to add/remove content from onboard storage
*
* This is a more targeted option to add new content compared to \a pfmRescanBooks
* and \a pfmRescanBooksFull. It is what the browser uses when downloading
* ebook files.
*
* Emits \a fssGotNumFilesToProcess signal to specify the number of files
* to be added, \a fssParseProgress to specify the current progress, and the
* \a fssFinished signal is emitted when complete.
*/
void NDBDbus::n3fssSyncOnboard() {
QStringList path("/mnt/onboard");
return n3fssSync(&path);
}

/*!
* \brief Begins a filesystem sync to add/remove content from sd storage
*
* This is a more targeted option to add new content compared to \a pfmRescanBooks
* and \a pfmRescanBooksFull. It is what the browser uses when downloading
* ebook files.
*
* Emits \a fssGotNumFilesToProcess signal to specify the number of files
* to be added, \a fssParseProgress to specify the current progress, and the
* \a fssFinished signal is emitted when complete.
*/
void NDBDbus::n3fssSyncSD() {
QStringList path("/mnt/sd");
return n3fssSync(&path);
}

/*!
* \brief Begins a filesystem sync to add/remove content from onboard and sd storage
*
* This is a more targeted option to add new content compared to \a pfmRescanBooks
* and \a pfmRescanBooksFull. It is what the browser uses when downloading
* ebook files.
*
* Emits \a fssGotNumFilesToProcess signal to specify the number of files
* to be added, \a fssParseProgress to specify the current progress, and the
* \a fssFinished signal is emitted when complete.
*/
void NDBDbus::n3fssSyncBoth() {
QStringList paths = QStringList() << "/mnt/onboard" << "/mnt/sd";
return n3fssSync(&paths);
Expand Down

0 comments on commit 5c8cabe

Please sign in to comment.