From ca93f02c621ea0f686e0bde3e4130e99116fd9d5 Mon Sep 17 00:00:00 2001 From: Vishal Lal Date: Wed, 2 Apr 2014 08:08:20 +0000 Subject: [PATCH] Fixed #22347 -- Unified FileSystemStorage documentation. Thanks nliberg for the report. --- docs/ref/files/storage.txt | 10 ++++++++++ docs/topics/files.txt | 16 ++-------------- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/docs/ref/files/storage.txt b/docs/ref/files/storage.txt index b29b083e5c..3fab257457 100644 --- a/docs/ref/files/storage.txt +++ b/docs/ref/files/storage.txt @@ -36,6 +36,16 @@ The FileSystemStorage Class :class:`~django.core.files.storage.Storage` and provides implementations for all the public methods thereof. + .. attribute:: location + + Absolute path to the directory that will hold the files. + Defaults to the value of your :setting:`MEDIA_ROOT` setting. + + .. attribute:: base_url + + URL that serves the files stored at this location. + Defaults to the value of your :setting:`MEDIA_URL` setting. + .. attribute:: file_permissions_mode The file system permissions that the file will receive when it is diff --git a/docs/topics/files.txt b/docs/topics/files.txt index 154d5c8ebb..af7568e933 100644 --- a/docs/topics/files.txt +++ b/docs/topics/files.txt @@ -149,20 +149,8 @@ See :doc:`/ref/files/storage` for the file storage API. The built-in filesystem storage class ------------------------------------- -Django ships with a built-in ``FileSystemStorage`` class (defined in -``django.core.files.storage``) which implements basic local filesystem file -storage. Its initializer takes two arguments: - -====================== =================================================== -Argument Description -====================== =================================================== -``location`` Optional. Absolute path to the directory that will - hold the files. If omitted, it will be set to the - value of your :setting:`MEDIA_ROOT` setting. -``base_url`` Optional. URL that serves the files stored at this - location. If omitted, it will default to the value - of your :setting:`MEDIA_URL` setting. -====================== =================================================== +Django ships with a :class:`django.core.files.storage.FileSystemStorage` class +which implements basic local filesystem file storage. For example, the following code will store uploaded files under ``/media/photos`` regardless of what your :setting:`MEDIA_ROOT` setting is::