Skip to content

Commit

Permalink
python docs: describe change of st_stat members
Browse files Browse the repository at this point in the history
  • Loading branch information
pstorz committed Sep 9, 2020
1 parent 7f37e9f commit 7ba41e8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/manuals/source/TasksAndConcepts/Plugins.rst
Expand Up @@ -202,6 +202,8 @@ During the restructuring of the plugin API it became clear that the *context*
that was always transferred between the core and the Python Plugin and back was
**unnecessary**, so it was completely removed from the API.

The members of the **bareosfd.stat_pkt** type have been renamed with the
**st_** prefix to match with the member names of Pythons' **os.stat_result**.

Porting existing Python plugins:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -216,6 +218,8 @@ and requires the following steps:
Switch to the constants being defined in the bareos[fd|sd|dir] Python plugin.
Import bareos[fd|sd|dir] instead of bareos_[fd|sd|dir]_consts.

Add the **st_** prefix to all members of **stat_pkt** type.

Adapt the code to run on Python 2 **and** Python 3
It is important to make sure the code works both for Python 2 and 3.
While the c++ code and the Python api have been reorganized, the Python
Expand Down

0 comments on commit 7ba41e8

Please sign in to comment.