mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
minor: fix/format doc for returners.local_cache.prep_jid
This commit is contained in:
parent
fd485e2396
commit
2a44255748
1 changed files with 7 additions and 5 deletions
|
@ -103,23 +103,25 @@ def _format_jid_instance(jid, job):
|
|||
#TODO: add to returner docs-- this is a new one
|
||||
def prep_jid(nocache=False, passed_jid=None, recurse_count=0):
|
||||
'''
|
||||
Return a job id and prepare the job id directory
|
||||
This is the function responsible for making sure jids don't collide (unless its passed a jid)
|
||||
Return a job id and prepare the job id directory.
|
||||
|
||||
This is the function responsible for making sure jids don't collide (unless
|
||||
it is passed a jid).
|
||||
So do what you have to do to make sure that stays the case
|
||||
'''
|
||||
if recurse_count >= 5:
|
||||
err = 'prep_jid could not store a jid after {0} tries.'.format(recurse_count)
|
||||
log.error(err)
|
||||
raise salt.exceptions.SaltCacheError(err)
|
||||
if passed_jid is None: # this can be a None of an empty string
|
||||
if passed_jid is None: # this can be a None or an empty string.
|
||||
jid = salt.utils.jid.gen_jid()
|
||||
else:
|
||||
jid = passed_jid
|
||||
|
||||
jid_dir_ = _jid_dir(jid)
|
||||
|
||||
# make sure we create the jid dir, otherwise someone else is using it,
|
||||
# meaning we need a new jid
|
||||
# Make sure we create the jid dir, otherwise someone else is using it,
|
||||
# meaning we need a new jid.
|
||||
try:
|
||||
os.makedirs(jid_dir_)
|
||||
except OSError:
|
||||
|
|
Loading…
Add table
Reference in a new issue