Fossil SCM
Make similar improvements to the documentation for /zip and /sqlar.
Commit
9eadac2026626b7153b7816981245d3d4335397fea497bd8595fa731a561b7f8
Parent
7cd1ebd093a47d2…
1 file changed
+31
-21
+31
-21
| --- src/zip.c | ||
| +++ src/zip.c | ||
| @@ -864,35 +864,45 @@ | ||
| 864 | 864 | |
| 865 | 865 | /* |
| 866 | 866 | ** WEBPAGE: sqlar |
| 867 | 867 | ** WEBPAGE: zip |
| 868 | 868 | ** |
| 869 | -** Generate a ZIP or SQL archive for the check-in specified by the "r" | |
| 870 | -** query parameter. Return the archive as the HTTP reply content. | |
| 871 | -** | |
| 872 | -** If the NAME contains one "/" then the part before the "/" is taken | |
| 873 | -** as the TAG and the part after the "/" becomes the true name. Hence, | |
| 874 | -** the following URLs are all equivalent: | |
| 875 | -** | |
| 876 | -** /sqlar/508c42a6398f8/download.sqlar | |
| 877 | -** /sqlar?r=508c42a6398f8&name=download.sqlar | |
| 878 | -** /sqlar/download.sqlar?r=508c42a6398f8 | |
| 879 | -** /sqlar?name=508c42a6398f8/download.sqlar | |
| 869 | +** URLs: | |
| 870 | +** | |
| 871 | +** /zip/VERSION/NAME.zip | |
| 872 | +** /sqlar/VERSION/NAME.sqlar | |
| 873 | +** | |
| 874 | +** Generate a ZIP Archive or an SQL Archive for the check-in specified by | |
| 875 | +** VERSION. The archive is called NAME.zip or NAME.sqlar and has a top-level | |
| 876 | +** directory called NAME. | |
| 877 | +** | |
| 878 | +** Alternatively, the VERSION can be specified using the r= query parameter. | |
| 879 | +** All of the following URLs are equivalent: | |
| 880 | +** | |
| 881 | +** /zip/release/xyz.zip | |
| 882 | +** /zip?r=release&name=xyz.zip | |
| 883 | +** /zip/xyz.zip?r=release | |
| 884 | +** /zip?name=release/xyz.zip | |
| 880 | 885 | ** |
| 881 | 886 | ** Query parameters: |
| 882 | 887 | ** |
| 883 | -** name=NAME The base name of the output file. The default | |
| 884 | -** value is a configuration parameter in the project | |
| 885 | -** settings. A prefix of the name, omitting the | |
| 886 | -** extension, is used as the top-most directory name. | |
| 888 | +** name=[CKIN/]NAME The optional CKIN component of the name= parameter | |
| 889 | +** identifies the check-in from which the archive is | |
| 890 | +** constructed. If CKIN is omitted and there is no | |
| 891 | +** r= query parameter, then use "trunk". NAME is the | |
| 892 | +** name of the download file. The top-level directory | |
| 893 | +** in the generated archive is called by NAME with the | |
| 894 | +** file extension removed. | |
| 887 | 895 | ** |
| 888 | -** r=TAG The check-in that is turned into a ZIP archive. | |
| 889 | -** Defaults to "trunk". This query parameter used to | |
| 890 | -** be called "uuid" and the older "uuid" name is still | |
| 891 | -** accepted for backwards compatibility. If this | |
| 892 | -** query parameter is omitted, the latest "trunk" | |
| 893 | -** check-in is used. | |
| 896 | +** r=TAG TAG identifies the check-in that is turned into an | |
| 897 | +** SQL or ZIP archive. The default value is "trunk". | |
| 898 | +** If r= is omitted and if the name= query parameter | |
| 899 | +** contains one "/" character then the of part the | |
| 900 | +** name= value before the / becomes the TAG and the | |
| 901 | +** part of the name= value after the / is the download | |
| 902 | +** filename. If no check-in is specified by either | |
| 903 | +** name= or r=, then "trunk" is used. | |
| 894 | 904 | ** |
| 895 | 905 | ** in=PATTERN Only include files that match the comma-separate |
| 896 | 906 | ** list of GLOB patterns in PATTERN, as with ex= |
| 897 | 907 | ** |
| 898 | 908 | ** ex=PATTERN Omit any file that match PATTERN. PATTERN is a |
| 899 | 909 |
| --- src/zip.c | |
| +++ src/zip.c | |
| @@ -864,35 +864,45 @@ | |
| 864 | |
| 865 | /* |
| 866 | ** WEBPAGE: sqlar |
| 867 | ** WEBPAGE: zip |
| 868 | ** |
| 869 | ** Generate a ZIP or SQL archive for the check-in specified by the "r" |
| 870 | ** query parameter. Return the archive as the HTTP reply content. |
| 871 | ** |
| 872 | ** If the NAME contains one "/" then the part before the "/" is taken |
| 873 | ** as the TAG and the part after the "/" becomes the true name. Hence, |
| 874 | ** the following URLs are all equivalent: |
| 875 | ** |
| 876 | ** /sqlar/508c42a6398f8/download.sqlar |
| 877 | ** /sqlar?r=508c42a6398f8&name=download.sqlar |
| 878 | ** /sqlar/download.sqlar?r=508c42a6398f8 |
| 879 | ** /sqlar?name=508c42a6398f8/download.sqlar |
| 880 | ** |
| 881 | ** Query parameters: |
| 882 | ** |
| 883 | ** name=NAME The base name of the output file. The default |
| 884 | ** value is a configuration parameter in the project |
| 885 | ** settings. A prefix of the name, omitting the |
| 886 | ** extension, is used as the top-most directory name. |
| 887 | ** |
| 888 | ** r=TAG The check-in that is turned into a ZIP archive. |
| 889 | ** Defaults to "trunk". This query parameter used to |
| 890 | ** be called "uuid" and the older "uuid" name is still |
| 891 | ** accepted for backwards compatibility. If this |
| 892 | ** query parameter is omitted, the latest "trunk" |
| 893 | ** check-in is used. |
| 894 | ** |
| 895 | ** in=PATTERN Only include files that match the comma-separate |
| 896 | ** list of GLOB patterns in PATTERN, as with ex= |
| 897 | ** |
| 898 | ** ex=PATTERN Omit any file that match PATTERN. PATTERN is a |
| 899 |
| --- src/zip.c | |
| +++ src/zip.c | |
| @@ -864,35 +864,45 @@ | |
| 864 | |
| 865 | /* |
| 866 | ** WEBPAGE: sqlar |
| 867 | ** WEBPAGE: zip |
| 868 | ** |
| 869 | ** URLs: |
| 870 | ** |
| 871 | ** /zip/VERSION/NAME.zip |
| 872 | ** /sqlar/VERSION/NAME.sqlar |
| 873 | ** |
| 874 | ** Generate a ZIP Archive or an SQL Archive for the check-in specified by |
| 875 | ** VERSION. The archive is called NAME.zip or NAME.sqlar and has a top-level |
| 876 | ** directory called NAME. |
| 877 | ** |
| 878 | ** Alternatively, the VERSION can be specified using the r= query parameter. |
| 879 | ** All of the following URLs are equivalent: |
| 880 | ** |
| 881 | ** /zip/release/xyz.zip |
| 882 | ** /zip?r=release&name=xyz.zip |
| 883 | ** /zip/xyz.zip?r=release |
| 884 | ** /zip?name=release/xyz.zip |
| 885 | ** |
| 886 | ** Query parameters: |
| 887 | ** |
| 888 | ** name=[CKIN/]NAME The optional CKIN component of the name= parameter |
| 889 | ** identifies the check-in from which the archive is |
| 890 | ** constructed. If CKIN is omitted and there is no |
| 891 | ** r= query parameter, then use "trunk". NAME is the |
| 892 | ** name of the download file. The top-level directory |
| 893 | ** in the generated archive is called by NAME with the |
| 894 | ** file extension removed. |
| 895 | ** |
| 896 | ** r=TAG TAG identifies the check-in that is turned into an |
| 897 | ** SQL or ZIP archive. The default value is "trunk". |
| 898 | ** If r= is omitted and if the name= query parameter |
| 899 | ** contains one "/" character then the of part the |
| 900 | ** name= value before the / becomes the TAG and the |
| 901 | ** part of the name= value after the / is the download |
| 902 | ** filename. If no check-in is specified by either |
| 903 | ** name= or r=, then "trunk" is used. |
| 904 | ** |
| 905 | ** in=PATTERN Only include files that match the comma-separate |
| 906 | ** list of GLOB patterns in PATTERN, as with ex= |
| 907 | ** |
| 908 | ** ex=PATTERN Omit any file that match PATTERN. PATTERN is a |
| 909 |