From f588b964d4443581b92daab4eea3859934e35c42 Mon Sep 17 00:00:00 2001
From: Michael Ernst {@code @GuardedBy({})} is the default type qualifier.
*
* The argument is a string or set of strings that indicates the expression(s) that must be held,
- * using the syntax of
+ * using the syntax of
* Java expressions described in the manual. The expressions evaluate to an intrinsic (built-in,
* synchronization) monitor or an explicit {@link java.util.concurrent.locks.Lock}. The expression
* {@code " The argument is a string or set of strings that indicates the expression(s) that must be held,
- * using the syntax of
+ * using the syntax of
* Java expressions described in the manual. The expressions evaluate to an intrinsic (built-in,
* synchronization) monitor, or an explicit {@link java.util.concurrent.locks.Lock}.
*
@@ -28,7 +28,7 @@
/**
* The Java expressions that need to be held.
*
- * @see Syntax of
+ * @see Syntax of
* Java expressions
*/
String[] value();
diff --git a/checker/src/org/checkerframework/checker/nullness/AbstractNullnessChecker.java b/checker/src/org/checkerframework/checker/nullness/AbstractNullnessChecker.java
index 89dde3fff3a..91bec965956 100644
--- a/checker/src/org/checkerframework/checker/nullness/AbstractNullnessChecker.java
+++ b/checker/src/org/checkerframework/checker/nullness/AbstractNullnessChecker.java
@@ -21,7 +21,7 @@
// which is allowed by default.
// Forbidding is sound and will eventually be the default.
// Allowing is unsound, as described in Section 3.3.4, "Nullness and arrays":
- // http://checker-framework.com/manual/#nullness-arrays
+ // https://checkerframework.org/manual/#nullness-arrays
// It is the default temporarily, until we improve the analysis to reduce false positives or we
// learn what advice to give programmers about avoid false positive warnings.
// See issue #986: https://github.com/typetools/checker-framework/issues/986
diff --git a/checker/src/org/checkerframework/checker/regex/RegexUtil.java b/checker/src/org/checkerframework/checker/regex/RegexUtil.java
index 3883a557a1d..68c3adfd350 100644
--- a/checker/src/org/checkerframework/checker/regex/RegexUtil.java
+++ b/checker/src/org/checkerframework/checker/regex/RegexUtil.java
@@ -17,7 +17,7 @@
* expression.
*
* For an example of intended use, see section Testing whether a string is a
+ * href="https://checkerframework.org/manual/#regexutil-methods">Testing whether a string is a
* regular expression in the Checker Framework manual.
*
* Runtime Dependency: Using this class introduces a runtime dependency. This means that
diff --git a/checker/tests/nullness-extra/shorthand/README b/checker/tests/nullness-extra/shorthand/README
index 44007ca1e49..a406bbc63ce 100644
--- a/checker/tests/nullness-extra/shorthand/README
+++ b/checker/tests/nullness-extra/shorthand/README
@@ -1,5 +1,5 @@
This is a test of the "checker shorthand" feature.
-See: http://checker-framework.com/manual/#shorthand-for-checkers
+See: https://checkerframework.org/manual/#shorthand-for-checkers
This test is not Nullness specific.
We have placed this test in this location because it has two preconditions:
diff --git a/docs/checker-framework-quick-start.html b/docs/checker-framework-quick-start.html
index b24a64daf13..d16553773fc 100644
--- a/docs/checker-framework-quick-start.html
+++ b/docs/checker-framework-quick-start.html
@@ -15,12 +15,12 @@
A pluggable type-checker, or “checker” for short, prevents certain run-time errors. For example, it can prove that your code never suffers a
-NullPointerException. Choose which checker you want to run from the list
+NullPointerException. Choose which checker you want to run from the list
of checkers.
-To install the Checker Framework, download and unzip
+To install the Checker Framework, download and unzip
the Checker Framework distribution:
checker-framework-2.1.7.zip.
-To run a checker, supply the
You write annotations in your code. Then, the checker
-verifies
+verifies
two facts: (1) the annotations you wrote are correct (they are consistent with your source code), and (2) your program will not suffer certain exceptions or errors at run time.
For the most part, you only need to write annotations on method signatures and fields.
-Most annotations within method bodies are inferred for you automatically.
+Most annotations within method bodies are inferred for you automatically.
Furthermore, each checker applies certain defaults to further reduce your
annotation burden; for example, using the
-Nullness
+Nullness
Checker, you do not need to write Checker Framework quick start guide
Or, the
@@ -29,7 +29,7 @@ Checker Framework quick start guide
-processor
command-line argument:
+To run a checker, supply the -processor
command-line argument:
@@ -38,7 +38,7 @@
Checker Framework quick start guide
Checker Framework quick start guide
""
, but does not include null
.
You write a type annotation right before a use of a type (on the same
-line), as in:
+line), as in:
@NonNull String s;
List<@Positive Integer> l;
@@ -81,14 +81,14 @@
Checker Framework quick start guide
@NonNull
, only
@Nullable
which appears less often.
See the manual for more
-tips
+tips
about writing annotations.
Checker Framework quick start guide
To learn more, you can read:
javacheck
to the Checker Framework compiler.Although the Checker Framework ships with + "https://checkerframework.org/manual/#introduction"> many checkers, you may wish to write your own checker because there are other run-time problems you wish to prevent. If you do not wish to write a new type-checker, feel free to skip this section @@ -220,7 +220,7 @@
For further explanations, see the Checker Framework manual, chapter How + "https://checkerframework.org/manual/#writing-a-checker">How to create a new checker.
Although the Checker Framework ships with + "https://checkerframework.org/manual/#introduction"> many checkers, you may wish to write your own checker because there are other run-time problems you wish to prevent. If you do not wish to write a new type-checker, feel free to skip this section @@ -253,7 +253,7 @@
For further explanations, see the Checker Framework manual, chapter How + "https://checkerframework.org/manual/#writing-a-checker">How to create a new checker.
javacheck
+ "https://checkerframework.org/manual/#installation">
an alias to the Checker Framework compiler.)
$ javacheck -processor org.checkerframework.checker.nullness.NullnessChecker NullnessExample.java diff --git a/docs/tutorial/webpages/get-started-eclipse.html b/docs/tutorial/webpages/get-started-eclipse.html index c3ff65fa3d5..6de0c9eabf1 100644 --- a/docs/tutorial/webpages/get-started-eclipse.html +++ b/docs/tutorial/webpages/get-started-eclipse.html @@ -11,7 +11,7 @@ + "https://checkerframework.org/favicon-checkerframework.png"> @@ -24,10 +24,10 @@
Run the buildfile:
(The Ant buildfile
makes use of the
+ "https://checkerframework.org/manual/#ant-task">
Checker Framework support for Ant.)
$ cd personalblog-demo @@ -215,7 +215,7 @@5. Re-run the Tainting Checker — no errors
For a complete discussion of how to use the Tainting Checker, please read the + "https://checkerframework.org/manual/#tainting-checker"> Tainting Checker chapter in the Checker Framework manual.
This example has already been annotated to prevent the SQL
injections. It does this by annotating
PersonalBlogService.executeQuery(String)
with
-
+
@Untainted
and providing a method,
ReadAction.validate(String)
, to validate the user
input.
For a complete discussion of how to use the Tainting Checker, please read the + "https://checkerframework.org/manual/#tainting-checker"> Tainting Checker chapter in the Checker Framework manual.
The right way to fix the problems is for the code to issue a
user-friendly message at run time. It should verify the user
input using the
- RegexUtil.isRegex(String, int)
method.
+ RegexUtil.isRegex(String, int)
method.
If the string is not a valid regular
expression, it should print an error message and halt.
If it is a valid regular expression, perform as before.
@@ -226,12 +226,12 @@
(If this issues an error
Exception in thread "main" java.lang.UnsupportedClassVersionError: RegexExample : Unsupported major.minor version 52.0-
, then change the , then change the For a full discussion of the Regex Checker, please see the
+ "https://checkerframework.org/manual/#regex-checker">
Regex Checker chapter of the Checker Framework manual.javacheck
+ javacheck
alias to pass the -source 7 -target 7
command-line
arguments and rerun the javacheck command.)
The right way to fix the problems is for the code to issue a
user-friendly message at run time. It should verify the user
input using the
- RegexUtil.isRegex(String, int)
method.
+ RegexUtil.isRegex(String, int)
method.
If the string is not a valid regular
expression, it should print an error message and halt.
If it is a valid regular expression, perform as before.
@@ -228,7 +228,7 @@
For a full discussion of the Regex Checker, please see the + "https://checkerframework.org/manual/#regex-checker"> Regex Checker chapter of the Checker Framework manual.
http://checker-framework.com/manual/#build-source
+ https://checkerframework.org/manual/#build-source
To test your plugin, you should install it locally. You can find installation instructions at:
- http://checker-framework.com/eclipse/
+ https://checkerframework.org/eclipse/
However, when installing the plugin, rather than using the above URL for the location of the
plugin, you should press the "Local" button and select the directory of your
checker-framework-update-site project. The IDE will treat that directory as an update site
@@ -609,8 +609,8 @@
When performing a release, you should test the "Getting Started" and "Validating User Input" guides from - the checker framework tutorial: - http://checker-framework.com/tutorial/ + the checker framework tutorial: + https://checkerframework.org/tutorial/
- The Checker Framework is a pluggable type-checking + The Checker Framework is a pluggable type-checking system for Java: It warns you, at compile time, about errors in your programs, beyond those that Java's built-in type-checker does. This document tells you how to get started using the - Checker Framework + Checker Framework in Eclipse.
Name: | Checker Framework |
Location: | http://checker-framework.com/eclipse |
Location: | https://checkerframework.org/eclipse |
Here is how to run one or more - built-in type checkers + built-in type checkers from the Checker Framework:
The Checker Framework
- also allows you to write a custom checker that enforces rules of your own.
+ also allows you to write a custom checker that enforces rules of your own.
To run a custom checker that you have written, do the following:
Processor/build options
The Checker Framework
- supports command-line options to its compiler (usually prefaced by -A). One
+ supports command-line options to its compiler (usually prefaced by -A). One
way to use these options is enabling the various options under the label "Processor/build options".
If you are using the
Checker Framework
on a project for which other developers are not, you may be specifically interested in its
- backward compatibility features, such as annotations in comments and
+ backward compatibility features, such as annotations in comments and
implicit import statement. If you check the box next to the text "Use implicit imports for annotation classes"
then, for built-in checkers, all of the appropriate annotations will be imported implicitly.
To get support for either the Checker Framework or this plugin please
first consult the
- Checker Framework Manual,
+ Checker Framework Manual,
specifically the chapter
-
+
"Troubleshooting and getting help"
.
If you find a bug, please report it at
diff --git a/framework/build.xml b/framework/build.xml
index f44a24a0d6e..e0482f18791 100644
--- a/framework/build.xml
+++ b/framework/build.xml
@@ -623,7 +623,7 @@
File Layout
/cse/www2/types
- The file system location of the website:
+
http://checker-framework.com/.The file system location of the website:
https://checkerframework.org/.
@@ -538,7 +538,7 @@
m2-repo
The location of the in-house Maven repository. It is accessed through URL:
- http://checker-framework.com/m2-repo
+ https://checkerframework.org/m2-repo
File Layout
/cse/www2/types/dev
- The file system location of the development staging website:
+
http://checker-framework.com/dev.The file system location of the development staging website:
https://checkerframework.org/dev.
@@ -568,17 +568,17 @@
@@ -551,7 +551,7 @@ File Layout
m2-repo
The location of the in-house staging version of the Maven repository. It is accessed through URL:
- http://checker-framework.com/dev/m2-repo
+ https://checkerframework.org/dev/m2-repo
Release Scripts
Reverts the build/interm repositories to the state of their master repositories in GitHub/Bitbucket.
It then builds the projects and all their artifacts and then stages a development
version of all websites to
- http://checker-framework.com/dev/
+ https://checkerframework.org/dev/
This script is thoroughly documented in code comments located in its
main()
function.
release_push.py
Verifies the release at
- http://checker-framework.com/dev/
+ https://checkerframework.org/dev/
is correct through scripts and manual steps. When the user is satisfied the website
is correct it deploys the website to the live website:
- http://checker-framework.com/.
+ https://checkerframework.org/.
It also pushes Maven artifacts to our checker-framework.com repo and Maven central.
Furthermore, there are a number of prompts to manually build the Eclipse plugin and
test various components.
@@ -625,13 +625,13 @@ Content Guidelines
Future Improvements
Open JDK/JSR308 Javadoc
Generating the Javadocs for the entire JDK is not simple. We have previously generated these but have
not updated them in a while. They can be found here:
- http://checker-framework.com/jdk-api/
+ https://checkerframework.org/jdk-api/
When we generate javadoc for the Type Annotations Compiler and Checker Framework we link against these docs.
But because they were generated in a faulty manner in the first place, there are many broken links related to
package summaries of the jdk-api docs. It is highly unlikely that users will ever run into these links, since
diff --git a/release/release_build.py b/release/release_build.py
index 0e0d4c958c5..02d785155de 100755
--- a/release/release_build.py
+++ b/release/release_build.py
@@ -494,7 +494,7 @@ def main(argv):
# The projects are built in the following order: JSR308-Langtools,
# Annotation File Utilities, and Checker Framework. Furthermore, their
# manuals and websites are also built and placed in their relevant locations
- # at http://checker-framework.com/dev/ . This is the most time-consuming
+ # at https://checkerframework.org/dev/ . This is the most time-consuming
# piece of the release. There are no prompts from this step forward; you
# might want to get a cup of coffee and do something else until it is done.
@@ -528,7 +528,7 @@ def main(argv):
commit_to_interm_projects(jsr308_version, afu_version, projects_to_release)
# Adds read/write/execute group permissions to all of the new dev website directories
- # under http://checker-framework.com/dev/ These directories need group read/execute
+ # under https://checkerframework.org/dev/ These directories need group read/execute
# permissions in order for them to be served.
print_step("\n\nBuild Step 9: Add group permissions to repos.")
diff --git a/release/release_push.py b/release/release_push.py
index e531116b706..8c4b9c984ae 100755
--- a/release/release_push.py
+++ b/release/release_push.py
@@ -197,7 +197,7 @@ def check_all_links(jsr308_website, afu_website, checker_website, suffix, test_m
afuCheck = run_link_checker(afu_website, TMP_DIR + "/afu." + suffix + ".check")
additional_param = ""
if checker_version_of_broken_link_to_suppress != "":
- additional_param = "--suppress-broken 404:http://checker-framework.com/checker-framework-" + checker_version_of_broken_link_to_suppress + ".zip"
+ additional_param = "--suppress-broken 404:https://checkerframework.org/checker-framework-" + checker_version_of_broken_link_to_suppress + ".zip"
checkerCheck = run_link_checker(checker_website, TMP_DIR + "/checker-framework." + suffix + ".check", additional_param)
is_jsr308Check_empty = is_file_empty(jsr308Check)
@@ -319,7 +319,7 @@ def main(argv):
print "AFU: current-version=%s new-version=%s" % (current_afu_version, new_afu_version)
# Runs the link the checker on all websites at:
- # http://checker-framework.com/dev/
+ # https://checkerframework.org/dev/
# The output of the link checker is written to files in the /scratch/$USER/jsr308-release directory
# whose locations will be output at the command prompt if the link checker reported errors.
@@ -350,7 +350,7 @@ def main(argv):
maven_sanity_check("maven-dev", MAVEN_DEV_REPO, new_checker_version)
print_step("3c: Build the Eclipse plugin and test.")
- print "Please download: http://checker-framework.com/dev/checker-framework/checker-framework-%s.zip" % new_checker_version
+ print "Please download: https://checkerframework.org/dev/checker-framework/checker-framework-%s.zip" % new_checker_version
print("Use the jars in the dist directory along with the instructions at " +
"checker-framework/eclipse/README-developers.html to build the Eclipse plugin.\n" +
"Please install this version in the latest version of Eclipse and follow the tutorial at:\n" +
@@ -428,7 +428,7 @@ def main(argv):
# Ensure that the jsr308-langtools javac works with the system-wide java launcher
if not os.path.isdir(SANITY_TEST_JSR308_LANGTOOLS_DIR):
execute("mkdir -p " + SANITY_TEST_JSR308_LANGTOOLS_DIR)
- execute("wget http://checker-framework.com/jsr308/jsr308-langtools-" + new_checker_version + ".zip", True, False, SANITY_TEST_JSR308_LANGTOOLS_DIR)
+ execute("wget https://checkerframework.org/jsr308/jsr308-langtools-" + new_checker_version + ".zip", True, False, SANITY_TEST_JSR308_LANGTOOLS_DIR)
execute("unzip -uq jsr308-langtools-" + new_checker_version +".zip", True, False, SANITY_TEST_JSR308_LANGTOOLS_DIR)
execute("env -i bash --noprofile jsr308-langtools-" + new_checker_version + "/dist/bin/javac -version", True, False, SANITY_TEST_JSR308_LANGTOOLS_DIR)
else:
@@ -446,7 +446,7 @@ def main(argv):
print "Test mode: Skipping deployment of the Eclipse Plugin to the live site."
# Runs the link the checker on all websites at:
- # http://checker-framework.com/
+ # https://checkerframework.org/
# The output of the link checker is written to files in the /scratch/$USER/jsr308-release directory whose locations
# will be output at the command prompt. Review the link checker output.
@@ -531,14 +531,14 @@ def main(argv):
msg = ("\n" +
"* Download the following files to your local machine." +
"\n" +
- "http://checker-framework.com/checker-framework-" + new_checker_version + ".zip\n" +
- "http://checker-framework.com/annotation-file-utilities/annotation-tools-" + new_afu_version + ".zip\n" +
+ "https://checkerframework.org/checker-framework-" + new_checker_version + ".zip\n" +
+ "https://checkerframework.org/annotation-file-utilities/annotation-tools-" + new_afu_version + ".zip\n" +
"\n" +
"To post the Checker Framework release on GitHub:\n" +
"\n" +
"* Go to https://github.com/typetools/checker-framework/releases/new?tag=checker-framework-" + new_checker_version + "\n" +
"* For the release title, enter: Checker Framework " + new_checker_version + "\n" +
- "* For the description, insert the latest Checker Framework changelog entry (available at http://checker-framework.com/changelog.txt). Please include the first line with the release version and date.\n" +
+ "* For the description, insert the latest Checker Framework changelog entry (available at https://checkerframework.org/changelog.txt). Please include the first line with the release version and date.\n" +
"* Find the link below \"Attach binaries by dropping them here or selecting them.\" Click on \"selecting them\" and upload checker-framework-" + new_checker_version + ".zip from your machine.\n" +
"* Click on the green \"Publish release\" button.\n" +
"\n" +
@@ -546,7 +546,7 @@ def main(argv):
"\n" +
"* Go to https://github.com/typetools/annotation-tools/releases/new?tag=" + new_afu_version + "\n" +
"* For the release title, enter: Annotation File Utilities " + new_afu_version + "\n" +
- "* For the description, insert the latest Annotation File Utilities changelog entry (available at http://checker-framework.com/annotation-file-utilities/changelog.html). Please include the first line with the release version and date. For bullet points, use the * Markdown character.\n" +
+ "* For the description, insert the latest Annotation File Utilities changelog entry (available at https://checkerframework.org/annotation-file-utilities/changelog.html). Please include the first line with the release version and date. For bullet points, use the * Markdown character.\n" +
"* Find the link below \"Attach binaries by dropping them here or selecting them.\" Click on \"selecting them\" and upload annotation-tools-" + new_afu_version + ".zip from your machine.\n" +
"* Click on the green \"Publish release\" button.\n")
diff --git a/release/release_vars.py b/release/release_vars.py
index 98054c7a26c..96ffb116f89 100755
--- a/release/release_vars.py
+++ b/release/release_vars.py
@@ -45,12 +45,12 @@ def append_to_PATH(paths):
MAX_DOWNLOAD_SIZE = 2000000000
# The location the test site is built in
-HTTP_PATH_TO_DEV_SITE = "http://checker-framework.com/dev"
+HTTP_PATH_TO_DEV_SITE = "https://checkerframework.org/dev"
FILE_PATH_TO_DEV_SITE = "/cse/www2/types/dev/checker-framework"
DEV_HTACCESS = os.path.join(FILE_PATH_TO_DEV_SITE, ".htaccess")
# The location the test site is pushed to when it is ready
-HTTP_PATH_TO_LIVE_SITE = "http://checker-framework.com"
+HTTP_PATH_TO_LIVE_SITE = "https://checkerframework.org"
FILE_PATH_TO_LIVE_SITE = "/cse/www2/types/checker-framework"
LIVE_HTACCESS = os.path.join(FILE_PATH_TO_LIVE_SITE, ".htaccess")
diff --git a/release/sanity_checks.py b/release/sanity_checks.py
index 24b27509698..a16891fb54c 100755
--- a/release/sanity_checks.py
+++ b/release/sanity_checks.py
@@ -65,7 +65,7 @@ def javac_sanity_check(checker_framework_website, release_version):
])
# this is a smoke test for the built-in checker shorthand feature
- # http://checker-framework.com/manual/#shorthand-for-checkers
+ # https://checkerframework.org/manual/#shorthand-for-checkers
nullness_shorthand_output = os.path.join(deploy_dir, "output_shorthand.log")
cmd = sanity_javac + " -processor NullnessChecker " + nullness_example + " -Anomsgtext"
execute_write_to_file(cmd, nullness_shorthand_output, False)
diff --git a/release/test-checker-framework.sh b/release/test-checker-framework.sh
index 61922990176..dfc4fa1a632 100755
--- a/release/test-checker-framework.sh
+++ b/release/test-checker-framework.sh
@@ -17,7 +17,7 @@ fi
rm -f checker-framework-$1.zip
rm -rf checker-framework-$1/
-wget http://checker-framework.com/checker-framework-$1.zip
+wget https://checkerframework.org/checker-framework-$1.zip
unzip -q checker-framework-$1.zip
export CHECKERFRAMEWORK=checker-framework-$1
diff --git a/release/types.htaccess b/release/types.htaccess
index b33275ff592..141bedb9997 100644
--- a/release/types.htaccess
+++ b/release/types.htaccess
@@ -9,7 +9,7 @@ Options +FollowSymlinks
# Redirect /specification/java-annotation-design.html /jsr308/specification/java-annotation-design.html
# Redirect /dev/specification/java-annotation-design.html /dev/jsr308/specification/java-annotation-design.html
# Don't remove this redirect. The old URL is
-# http://checker-framework.com/checkers-manual.html
+# https://checkerframework.org/checkers-manual.html
# is referenced from
# https://blogs.oracle.com/java-platform-group/entry/java_8_s_new_type
# and perhaps from elsewhere.