[Django] #32176: Filesystem caching documentation incorrect

[Django]

#32176: Filesystem caching documentation incorrect
-------------------------------------+-------------------------------------
Reporter: Carles | Owner: Carles Pina Estany
Pina Estany |
Type: Bug | Status: assigned
Component: | Version: master
Documentation |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 1
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-------------------------------------+-------------------------------------
In: https://docs.djangoproject.com/en/3.1/topics/cache/#filesystem-caching

It says that {{{LOCATION}}} needs to exist. But the code creates it if it
doesn't exist:
https://github.com/django/django/blob/354c1524b38c9b9f052c1d78dcbfa6ed5559aeb3/django/core/cache/backends/filebased.py#L116
called from
https://github.com/django/django/blob/master/django/core/cache/backends/filebased.py#L23

Current documentation:
{{{Make sure the directory pointed-to by this setting exists and is
readable and writable by the system user under which your Web server runs.
Continuing the above example, if your server runs as the user apache, make
sure the directory /var/tmp/django_cache exists and is readable and
writable by the user apache.}}}

PR coming soon.

--
Ticket URL: <https://code.djangoproject.com/ticket/32176>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#32176: Filesystem caching documentation incorrect
-------------------------------------+-------------------------------------

Reporter: Carles Pina Estany | Owner: Carles

| Pina Estany
Type: Bug | Status: assigned

Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carles Pina Estany):

See PR: https://github.com/django/django/pull/13649

--
Ticket URL: <https://code.djangoproject.com/ticket/32176#comment:1>

[Django]

#32176: Filesystem caching documentation incorrect
-------------------------------------+-------------------------------------

Reporter: Carles Pina Estany | Owner: Carles

| Pina Estany
Type: Bug | Status: assigned

Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Carles Pina Estany):

* cc: Carles Pina Estany (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/32176#comment:2>

[Django]

#32176: Filesystem caching documentation incorrect
-------------------------------------+-------------------------------------

Reporter: Carles Pina Estany | Owner: Carles

| Pina Estany
Type: Bug | Status: assigned

Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Description changed by Carles Pina Estany:

Old description:

> In: https://docs.djangoproject.com/en/3.1/topics/cache/#filesystem-

> caching
>
> It says that {{{LOCATION}}} needs to exist. But the code creates it if it
> doesn't exist:
> https://github.com/django/django/blob/354c1524b38c9b9f052c1d78dcbfa6ed5559aeb3/django/core/cache/backends/filebased.py#L116
> called from
> https://github.com/django/django/blob/master/django/core/cache/backends/filebased.py#L23
>
> Current documentation:
> {{{Make sure the directory pointed-to by this setting exists and is
> readable and writable by the system user under which your Web server
> runs. Continuing the above example, if your server runs as the user
> apache, make sure the directory /var/tmp/django_cache exists and is
> readable and writable by the user apache.}}}
>
> PR coming soon.

New description:

In: https://docs.djangoproject.com/en/3.1/topics/cache/#filesystem-caching

It says that {{{LOCATION}}} needs to exist. But the code creates it if it
doesn't exist:
https://github.com/django/django/blob/354c1524b38c9b9f052c1d78dcbfa6ed5559aeb3/django/core/cache/backends/filebased.py#L116
called from
https://github.com/django/django/blob/master/django/core/cache/backends/filebased.py#L23

Current documentation:
{{{Make sure the directory pointed-to by this setting exists and is
readable and writable by the system user under which your Web server runs.
Continuing the above example, if your server runs as the user apache, make
sure the directory /var/tmp/django_cache exists and is readable and
writable by the user apache.}}}

PR: https://github.com/django/django/pull/13649

--

--
Ticket URL: <https://code.djangoproject.com/ticket/32176#comment:3>

[Django]

#32176: Outdated LOCATION requirement in Filesystem caching docs.

-------------------------------------+-------------------------------------
Reporter: Carles Pina Estany | Owner: Carles

Type: | Pina Estany
Cleanup/optimization | Status: assigned

Component: Documentation | Version: master
Severity: Normal | Resolution:

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak):

* type: Bug => Cleanup/optimization
* stage: Unreviewed => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/32176#comment:4>

[Django]

#32176: Outdated LOCATION requirement in Filesystem caching docs.
-------------------------------------+-------------------------------------
Reporter: Carles Pina Estany | Owner: Carles
Type: | Pina Estany
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Carlton Gibson):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/32176#comment:5>

[Django]

#32176: Outdated LOCATION requirement in Filesystem caching docs.
-------------------------------------+-------------------------------------
Reporter: Carles Pina Estany | Owner: Carles
Type: | Pina Estany

Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by GitHub <noreply@…>):

* status: assigned => closed
* resolution: => fixed

Comment:

In [changeset:"a43e2f66d76fddd791ff0b88361faba304447ff9" a43e2f66]:
{{{
#!CommitTicketReference repository=""
revision="a43e2f66d76fddd791ff0b88361faba304447ff9"
Fixed #32176 -- Clarified filesystem cache docs.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32176#comment:6>

[Django]

#32176: Outdated LOCATION requirement in Filesystem caching docs.
-------------------------------------+-------------------------------------
Reporter: Carles Pina Estany | Owner: Carles
Type: | Pina Estany
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton.gibson@…>):

In [changeset:"09dbae21c986514af41098bd3b3d7676a535281c" 09dbae21]:
{{{
#!CommitTicketReference repository=""
revision="09dbae21c986514af41098bd3b3d7676a535281c"
[3.1.x] Fixed #32176 -- Clarified filesystem cache docs.

Backport of a43e2f66d76fddd791ff0b88361faba304447ff9 from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32176#comment:7>