From 0c1e7b035d3e4af84f50f89786ac6fe5a8894124 Mon Sep 17 00:00:00 2001 From: Frederic Suter Date: Thu, 19 Sep 2019 18:14:27 +0200 Subject: [PATCH] update documentation --- docs/source/Configuring_SimGrid.rst | 2 +- docs/source/Tutorial_Algorithms.rst | 6 ++--- docs/source/XML_Reference.rst | 8 +++--- docs/source/app_s4u.rst | 38 ++++++++++++++--------------- docs/source/platform.rst | 2 +- examples/s4u/README.rst | 10 ++++---- include/simgrid/s4u/Disk.hpp | 10 ++++---- include/simgrid/s4u/Io.hpp | 2 +- 8 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/source/Configuring_SimGrid.rst b/docs/source/Configuring_SimGrid.rst index b4c000c6aa..b525c737ab 100644 --- a/docs/source/Configuring_SimGrid.rst +++ b/docs/source/Configuring_SimGrid.rst @@ -183,7 +183,7 @@ Configuring the Platform Models Choosing the Platform Models ............................ -SimGrid comes with several network, CPU and storage models built in, +SimGrid comes with several network, CPU and disk models built in, and you can change the used model at runtime by changing the passed configuration. The three main configuration items are given below. For each of these items, passing the special ``help`` value gives you diff --git a/docs/source/Tutorial_Algorithms.rst b/docs/source/Tutorial_Algorithms.rst index e8420ddce1..562a0cc853 100644 --- a/docs/source/Tutorial_Algorithms.rst +++ b/docs/source/Tutorial_Algorithms.rst @@ -12,7 +12,7 @@ execute user-provided functions. The actors have to explicitly use the S4U interface to express their computation, communication, disk usage and other |Activities|_, so that they get reflected within the simulator. These activities take place on **Resources** (|Hosts|_, -|Links|_, |Storages|_). SimGrid predicts the time taken by each +|Links|_, |Disks|_). SimGrid predicts the time taken by each activity and orchestrates accordingly the actors waiting for the completion of these activities. @@ -33,8 +33,8 @@ between communicating actors. .. |Links| replace:: **Links** .. _Links: app_s4u.html#s4u-link -.. |Storages| replace:: **Storages** -.. _Storages: app_s4u.html#s4u-storage +.. |Disks| replace:: **Disks** +.. _Disks: app_s4u.html#s4u-disk .. |VirtualMachines| replace:: **VirtualMachines** .. _VirtualMachines: app_s4u.html#s4u-virtualmachine diff --git a/docs/source/XML_Reference.rst b/docs/source/XML_Reference.rst index 8c39d22684..1f509f0aa8 100644 --- a/docs/source/XML_Reference.rst +++ b/docs/source/XML_Reference.rst @@ -63,7 +63,7 @@ name of the flag and ``value`` is what it has to be set to. A host is the computing resource on which an actor can run. See :cpp:class:`simgrid::s4u::Host`. **Parent tags:** :ref:`pf_tag_zone` (only leaf zones, i.e., zones containing neither inner zones nor clusters) |br| -**Children tags:** :ref:`pf_tag_mount`, :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br| +**Children tags:** :ref:`pf_tag_mount`, :ref:`pf_tag_prop`, :ref:`pf_tag_disk` |br| **Attributes:** :``id``: Host name. @@ -329,11 +329,12 @@ following functions: - Cluster: this is a zone, see below. - Host: :cpp:func:`simgrid::s4u::Host::get_property` or :cpp:func:`MSG_host_get_property_value` - Link: :cpp:func:`simgrid::s4u::Link::get_property` -- Storage: :cpp:func:`simgrid::s4u::Storage::get_property` or :cpp:func:`MSG_storage_get_property_value` +- Disk: :cpp:func:`simgrid::s4u::Disk::get_property` +- Storage :cpp:func:`MSG_storage_get_property_value` (deprecated) - Zone: :cpp:func:`simgrid::s4u::Zone::get_property` of :cpp:func:`MSG_zone_get_property_value` **Parent tags:** :ref:`pf_tag_actor`, :ref:`pf_tag_config`, :ref:`pf_tag_cluster`, :ref:`pf_tag_host`, -:ref:`pf_tag_link`, :ref:`pf_tag_storage`, :ref:`pf_tag_zone` |br| +:ref:`pf_tag_link`, :ref:`pf_tag_disk`,:ref:`pf_tag_storage` (deprecated), :ref:`pf_tag_zone` |br| **Children tags:** none |br| **Attributes:** @@ -373,7 +374,6 @@ particular, they are useful when you want to use the NS3 bindings to break the routes that are longer than 1 hop. **Parent tags:** :ref:`pf_tag_zone` (only leaf zones, i.e., zones containing neither inner zones nor clusters) |br| -**Children tags:** :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br| **Attributes:** :``id``: Router name. diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 0f6b24a280..885a6a932d 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -39,7 +39,7 @@ S4U interface to express their :ref:`computation `, :ref:`communication `, :ref:`disk usage `, and other |API_s4u_Activities|_, so that they get reflected within the simulator. These activities take place on resources such as |API_s4u_Hosts|_, -|API_s4u_Links|_ and |API_s4u_Storages|_. SimGrid predicts the time taken by each +|API_s4u_Links|_ and |API_s4u_Disks|_. SimGrid predicts the time taken by each activity and orchestrates the actors accordingly, waiting for the completion of these activities. @@ -75,14 +75,14 @@ provides many helper functions to simplify the code of actors. - **Platform Elements** + - :ref:`class s4u::Disk ` + Resource on which actors can write and read data. - :ref:`class s4u::Host `: Actor location, providing computational power. - :ref:`class s4u::Link ` Interconnecting hosts. - :ref:`class s4u::NetZone `: Sub-region of the platform, containing resources (Hosts, Links, etc). - - :ref:`class s4u::Storage ` - Resource on which actors can write and read data. - :ref:`class s4u::VirtualMachine `: Execution containers that can be moved between Hosts. @@ -94,7 +94,7 @@ provides many helper functions to simplify the code of actors. - :ref:`class s4u::Exec ` Computation activity, started on Host and consuming CPU resources. - :ref:`class s4u::Io ` - I/O activity, started on and consumming Storages. + I/O activity, started on and consumming disks. - **Synchronization Mechanisms**: Classical IPC that actors can use @@ -116,8 +116,8 @@ provides many helper functions to simplify the code of actors. .. |API_s4u_Links| replace:: **Links** .. _API_s4u_Links: #s4u-link -.. |API_s4u_Storages| replace:: **Storages** -.. _API_s4u_Storages: #s4u-storage +.. |API_s4u_Disks| replace:: **Disks** +.. _API_s4u_Disks: #s4u-disk .. |API_s4u_VirtualMachine| replace:: **VirtualMachines** @@ -179,8 +179,8 @@ Every kind of activity can be asynchronous: :cpp:func:`s4u::Mailbox::put_async() ` and :cpp:func:`s4u::Mailbox::get_async() `. - :ref:`s4u::IoPtr ` are created with - :cpp:func:`s4u::Storage::read_async() ` and - :cpp:func:`s4u::Storage::write_async() `. + :cpp:func:`s4u::Disk::read_async() ` and + :cpp:func:`s4u::Disk::write_async() `. - :ref:`s4u::ExecPtr ` are created with :cpp:func:`s4u::Host::exec_async() `. - In the future, it will become possible to have asynchronous IPC @@ -444,6 +444,17 @@ s4u::ConditionVariable :protected-members: :undoc-members: +.. _API_s4u_Disk: + +============ +s4u::Disk +============ + +.. doxygenclass:: simgrid::s4u::Disk + :members: + :protected-members: + :undoc-members: + .. _API_s4u_Engine: =========== @@ -579,17 +590,6 @@ s4u::Semaphore :protected-members: :undoc-members: -.. _API_s4u_Storage: - -============ -s4u::Storage -============ - -.. doxygenclass:: simgrid::s4u::Storage - :members: - :protected-members: - :undoc-members: - .. _API_s4u_VirtualMachine: =================== diff --git a/docs/source/platform.rst b/docs/source/platform.rst index d7e20e1da6..bc020e714c 100644 --- a/docs/source/platform.rst +++ b/docs/source/platform.rst @@ -29,7 +29,7 @@ documentation also contains some :ref:`hints and howtos `, as well as the full :ref:`XML reference guide `. -Any simulated platform must contain **basic elements**, such as hosts, links, storages, etc. SimGrid gives you a great +Any simulated platform must contain **basic elements**, such as hosts, links, disks, etc. SimGrid gives you a great liberty when defining the **routing of your platform**, i.e., the network path taken between each pair of hosts. Finally, you may also describe an **experimental scenario**, with qualitative (e.g., bandwidth variations representing an external load) and qualitative (e.g., representing how some elements fail and restart over time) changes. diff --git a/examples/s4u/README.rst b/examples/s4u/README.rst index 28d69f72b4..027d3b84ef 100644 --- a/examples/s4u/README.rst +++ b/examples/s4u/README.rst @@ -241,13 +241,13 @@ I/O on Disks and Files ---------------------- SimGrid provides two levels of abstraction to interact with the -simulated storages. At the simplest level, you simply create read and -write actions on the storage resources. +simulated disks. At the simplest level, you simply create read and +write actions on the disk resources. - - **Access to raw storage devices:** + - **Access to raw disk devices:** This example illustrates how to simply read and write data on a - simulated storage resource. - |br| `examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp `_ + simulated disk resource. + |br| `examples/s4u/io-disk-raw/s4u-io-disk-raw.cpp `_ The FileSystem plugin provides a more detailed view, with the classical operations over files: open, move, unlink, and of course diff --git a/include/simgrid/s4u/Disk.hpp b/include/simgrid/s4u/Disk.hpp index 6aa867a229..106da72666 100644 --- a/include/simgrid/s4u/Disk.hpp +++ b/include/simgrid/s4u/Disk.hpp @@ -37,16 +37,16 @@ protected: virtual ~Disk() = default; public: - /** @brief Callback signal fired when a new Storage is created */ + /** @brief Callback signal fired when a new Disk is created */ static xbt::signal on_creation; - /** @brief Callback signal fired when a Storage is destroyed */ + /** @brief Callback signal fired when a Disk is destroyed */ static xbt::signal on_destruction; - /** @brief Callback signal fired when a Storage's state changes */ + /** @brief Callback signal fired when a Disk's state changes */ static xbt::signal on_state_change; - /** @brief Retrieves the name of that storage as a C++ string */ + /** @brief Retrieves the name of that disk as a C++ string */ std::string const& get_name() const { return name_; } - /** @brief Retrieves the name of that storage as a C string */ + /** @brief Retrieves the name of that disk as a C string */ const char* get_cname() const { return name_.c_str(); } const std::unordered_map* get_properties() const; diff --git a/include/simgrid/s4u/Io.hpp b/include/simgrid/s4u/Io.hpp index 73593abf41..0ca0145b61 100644 --- a/include/simgrid/s4u/Io.hpp +++ b/include/simgrid/s4u/Io.hpp @@ -17,7 +17,7 @@ namespace s4u { /** I/O Activity, representing the asynchronous disk access. * - * They are generated from Storage::io_init() or Storage::read() and Storage::write(). + * They are generated from Disk::io_init(), Disk::read() Disk::read_async(), Disk::write() and Disk::write_async(). */ class XBT_PUBLIC Io : public Activity { -- 2.20.1