WIP: doc

doc/attributes.md

@@ -15,10 +15,10 @@ The YaST UI for creating and editing a user offers the following attributes:
 | disable login | * password starting by `!` | | | |
 | uid | `#uid` | | | |
 | home dir | `Home#path` | | | | |
-| home dir permission | `Home#create_mode` | yes | | `useradd -K HOME_MODE=755` |
-| empty home | `Home#create_with_content` | yes | | `rm -rf` after creating. No way to ignore `/usr/etc/skel` |
-| Move to new location | `Home#move_content` | | yes |  |
-| Btrfs subvolume | `Home#create_as_btrfs_subvol` | | | |
+| home dir permission | `Home#mode` | yes | | `useradd -K HOME_MODE=755` |
+| empty home | `Home#use_skel` | yes | | `rm -rf` after creating. No way to ignore `/usr/etc/skel` |
+| Move to new location | `Home#move` | | yes |  |
+| Btrfs subvolume | `Home#btrfs_subvol` | | | |
 | Additional info | `#gecos` | | | |
 | login shell | `#shell` | | | |
 | group | `#primary_group` | | | |
@@ -73,41 +73,39 @@ This section describes how the YaST users client behaves when dealing with the u
 
 #### Home representation in `Y2Users`
 
-WIP
-
 ~~~
 Y2Users::Home
   #path
-  #create_as_btrfs_subvol
-  #create_mode
-  #create_with_content
-  #move_content
-  #adapt_ownership
+  #btrfs_subvol
+  #mode
+  #use_skel
+  #move
+  #ownership
 ~~~
 
 * Use cases
   * create a new user with a home (`home#path` is not empty)
     * if the path already exists:
       * re-use existing home
-      * adapt ownership (`home#adapt_ownership`)
+      * adapt ownership (`home#ownership`)
     * if the path does not exist:
-      * create new home as dir/subvolume (`home#create_as_btrfs_subvol`)
-      * create with/without content (`home#create_with_content`)
-      * create with custom permissions (`home#create_mode`)
+      * create new home as dir/subvolume (`home#btrfs_subvol`)
+      * create with/without content (`home#use_skel`)
+      * create with custom permissions (`home#mode`)
   * create a new user without a home (`home#path` is empty)
     * do not create a home on disk
   * edit a user and add a home (`home#path` is not empty anymore)
     * if the path already exists:
       * re-use existing home
-      * adapt ownership (`home#adapt_ownership`)
+      * adapt ownership (`home#ownership`)
     * if the path does not exist:
       * Create a home (TODO: Not supported by shadow tools)
   * edit a user and change the home (`home#path` changes)
     * if the path already exists:
       * re-use existing home
-      * adapt ownership (`home#adapt_ownership`)
+      * adapt ownership (`home#ownership`)
     * if the path does not exist:
-      * if the home should be moved (`home#move_content`)
+      * if the home should be moved (`home#move`)
         * move home
       * if the home should not be moved:
         * create a home (TODO: Not supported by shadow tools)