mirror of
https://github.com/parchlinux/calamares.git
synced 2025-07-03 04:15:37 -04:00
[libcalamares] Tidy up documentation for System::runCommand
- Make explicit which one runs in the host, which one is selectable. - Document *location* parameter in the selectable version. - Tidy up alignment of apidox.
This commit is contained in:
parent
00293d1111
commit
b4aca7e188
1 changed files with 25 additions and 23 deletions
|
@ -139,8 +139,9 @@ public:
|
||||||
RunInTarget
|
RunInTarget
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/** @brief Runs a command in the host or the target (select explicitly)
|
||||||
* Runs the specified command in the chroot of the target system.
|
*
|
||||||
|
* @param location whether to run in the host or the target
|
||||||
* @param args the command with arguments, as a string list.
|
* @param args the command with arguments, as a string list.
|
||||||
* @param workingPath the current working directory for the QProcess
|
* @param workingPath the current working directory for the QProcess
|
||||||
* call (optional).
|
* call (optional).
|
||||||
|
@ -162,9 +163,9 @@ public:
|
||||||
const QString& stdInput = QString(),
|
const QString& stdInput = QString(),
|
||||||
std::chrono::seconds timeoutSec = std::chrono::seconds( 0 ) );
|
std::chrono::seconds timeoutSec = std::chrono::seconds( 0 ) );
|
||||||
|
|
||||||
/** @brief Convenience wrapper for runCommand()
|
/** @brief Convenience wrapper for runCommand() in the host
|
||||||
*
|
*
|
||||||
* Runs the given command-line @p args in the host in the current direcory
|
* Runs the given command-line @p args in the **host** in the current direcory
|
||||||
* with no input, and the given @p timeoutSec for completion.
|
* with no input, and the given @p timeoutSec for completion.
|
||||||
*/
|
*/
|
||||||
static inline ProcessResult runCommand( const QStringList& args, std::chrono::seconds timeoutSec )
|
static inline ProcessResult runCommand( const QStringList& args, std::chrono::seconds timeoutSec )
|
||||||
|
@ -173,6 +174,7 @@ public:
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @brief Convenience wrapper for runCommand().
|
/** @brief Convenience wrapper for runCommand().
|
||||||
|
*
|
||||||
* Runs the command in the location specified through the boolean
|
* Runs the command in the location specified through the boolean
|
||||||
* doChroot(), which is what you usually want for running commands
|
* doChroot(), which is what you usually want for running commands
|
||||||
* during installation.
|
* during installation.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue