From 1df74e8517429f40cf851432d5e1e7f5f170b56d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Iv=C3=A1n=20L=C3=B3pez=20Gonz=C3=A1lez?= Date: Wed, 18 Dec 2024 15:59:26 +0000 Subject: [PATCH] storage: add links to documentation --- service/lib/agama/storage/config.rb | 5 ++++- service/lib/agama/storage/config_conversions/from_json.rb | 3 +++ service/lib/agama/storage/config_json_solver.rb | 3 +++ service/lib/agama/storage/config_solver.rb | 3 +++ service/lib/agama/storage/configs/size.rb | 2 ++ 5 files changed, 15 insertions(+), 1 deletion(-) diff --git a/service/lib/agama/storage/config.rb b/service/lib/agama/storage/config.rb index 928c787b30..dbc249223d 100644 --- a/service/lib/agama/storage/config.rb +++ b/service/lib/agama/storage/config.rb @@ -25,7 +25,10 @@ module Agama module Storage - # Settings used to calculate an storage proposal. + # Config used to calculate an storage proposal. + # + # See doc/storage_proposal_from_profile.md for a complete description of how the config is + # generated from a profile. class Config include Copyable diff --git a/service/lib/agama/storage/config_conversions/from_json.rb b/service/lib/agama/storage/config_conversions/from_json.rb index 86cddab38a..61c1f66127 100644 --- a/service/lib/agama/storage/config_conversions/from_json.rb +++ b/service/lib/agama/storage/config_conversions/from_json.rb @@ -27,6 +27,9 @@ module Agama module Storage module ConfigConversions # Config conversion from JSON hash according to schema. + # + # See doc/storage_proposal_from_profile.md for a complete description of how the config is + # generated from a profile. class FromJSON # @param config_json [Hash] # @param default_paths [Array] Default paths of the product. diff --git a/service/lib/agama/storage/config_json_solver.rb b/service/lib/agama/storage/config_json_solver.rb index 3f05dda4af..06e8ba4663 100644 --- a/service/lib/agama/storage/config_json_solver.rb +++ b/service/lib/agama/storage/config_json_solver.rb @@ -57,6 +57,9 @@ module Storage # } # ] # } + # + # See doc/storage_proposal_from_profile.md for a complete description of how the config is + # generated from a profile. class ConfigJSONSolver # @param default_paths [Array] Default paths of the product. # @param mandatory_paths [Array] Mandatory paths of the product. diff --git a/service/lib/agama/storage/config_solver.rb b/service/lib/agama/storage/config_solver.rb index 3ec4084c5c..1fbff4e1fe 100644 --- a/service/lib/agama/storage/config_solver.rb +++ b/service/lib/agama/storage/config_solver.rb @@ -31,6 +31,9 @@ module Storage # Solving a config means to assign proper values according to the product and the system. For # example, the sizes of a partition config taking into account its fallbacks, assigning a # specific device when a config has a search, etc. + # + # See doc/storage_proposal_from_profile.md for a complete description of how the config is + # generated from a profile. class ConfigSolver # @param devicegraph [Y2Storage::Devicegraph] initial layout of the system # @param product_config [Agama::Config] configuration of the product to install diff --git a/service/lib/agama/storage/configs/size.rb b/service/lib/agama/storage/configs/size.rb index 98cc1f1645..424ae12917 100644 --- a/service/lib/agama/storage/configs/size.rb +++ b/service/lib/agama/storage/configs/size.rb @@ -36,6 +36,8 @@ def self.new_for_shrink_if_needed end end + # Whether the size is the default size for the volume. + # # @return [Boolean] attr_accessor :default alias_method :default?, :default