Merge pull request #3679 from alfredxing/remove-relative-permalinks

Merge pull request 3679

lib/jekyll/commands/doctor.rb

@@ -36,16 +36,12 @@ module Jekyll
         end
 
         def deprecated_relative_permalinks(site)
-          contains_deprecated_pages = false
+          if site.config['relative_permalinks']
-          site.pages.each do |page|
+            Jekyll::Deprecator.deprecation_message "Your site still uses relative" +
-            if page.uses_relative_permalinks
+                                " permalinks, which was removed in" +
-              Jekyll::Deprecator.deprecation_message "'#{page.path}' uses relative" +
+                                " Jekyll v3.0.0."
-                                  " permalinks which will be deprecated in" +
+            return true
-                                  " Jekyll v2.0.0 and beyond."
-              contains_deprecated_pages = true
-            end
           end
-          contains_deprecated_pages
         end
 
         def conflicting_urls(site)

lib/jekyll/configuration.rb

@@ -45,9 +45,6 @@ module Jekyll
       'host'          => '127.0.0.1',
       'baseurl'       => '',
 
-      # Backwards-compatibility options
-      'relative_permalinks' => false,
-
       # Output Configuration
       'permalink'     => 'date',
       'paginate_path' => '/page:num',

lib/jekyll/page.rb

@@ -52,11 +52,7 @@ module Jekyll
     # Returns the String permalink or nil if none has been set.
     def permalink
       return nil if data.nil? || data['permalink'].nil?
-      if site.config['relative_permalinks']
+      data['permalink']
-        File.join(@dir, data['permalink'])
-      else
-        data['permalink']
-      end
     end
 
     # The template of the permalink.
@@ -156,9 +152,5 @@ module Jekyll
     def index?
       basename == 'index'
     end
-
-    def uses_relative_permalinks
-      permalink && !@dir.empty? && site.config['relative_permalinks']
-    end
   end
 end

lib/jekyll/site.rb

@@ -287,12 +287,12 @@ module Jekyll
     #
     # Returns
     def relative_permalinks_are_deprecated
-    if config['relative_permalinks'] && has_relative_page?
+      if config['relative_permalinks']
-        Jekyll::Deprecator.deprecation_message "Since v2.0, permalinks for pages" +
+        Jekyll.logger.abort_with "Since v3.0, permalinks for pages" +
-                                            " in subfolders must be relative to the" +
+                                " in subfolders must be relative to the" +
-                                            " site source directory, not the parent" +
+                                " site source directory, not the parent" +
-                                            " directory. Check http://jekyllrb.com/docs/upgrading/"+
+                                " directory. Check http://jekyllrb.com/docs/upgrading/"+
-                                            " for more info."
+                                " for more info."
       end
     end
 
@@ -370,14 +370,6 @@ module Jekyll
 
     private
 
-    # Checks if the site has any pages containing relative links
-    #
-    # Returns a Boolean: true for usage of relateive permalinks, false
-    # if it doesn't
-    def has_relative_page?
-      pages.any? { |page| page.uses_relative_permalinks }
-    end
-
     # Limits the current posts; removes the posts which exceed the limit_posts
     #
     # Returns nothing

site/_config.yml

@@ -1,6 +1,5 @@
 markdown: kramdown
 highlighter: pygments
-relative_permalinks: false
 permalink: /news/:year/:month/:day/:title/
 excerpt_separator: ""
 

site/_docs/configuration.md

@@ -502,9 +502,6 @@ port:    4000
 host:    127.0.0.1
 baseurl: "" # does not include hostname
 
-# Backwards-compatibility
-relative_permalinks: false
-
 # Outputting
 permalink:     date
 paginate_path: /page:num

site/_docs/upgrading.md

@@ -42,19 +42,12 @@ your site.
 In Jekyll v1.0, we introduced absolute permalinks for pages in
 subdirectories. Starting with v2.0, absolute permalinks are opt-out,
 meaning Jekyll will default to using absolute permalinks instead of
-relative permalinks.
+relative permalinks. Relative permalink backwards-compatibility was removed in v3.0.
-
-* To use absolute permalinks, set `relative_permalinks: false` in your
-configuration file.
-* To continue using relative permalinks, set `relative_permalinks: true` in
-your configuration file.
 
 <div class="note warning" id="absolute-permalinks-warning">
-  <h5 markdown="1">Absolute permalinks will be default in v2.0 and on</h5>
+  <h5 markdown="1">Absolute permalinks will be required in v3.0 and on</h5>
   <p markdown="1">
-    Starting with Jekyll v2.0, `relative_permalinks` will default to `false`,
+    Starting with Jekyll v3.0, relative permalinks functionality will be removed and thus unavailable for use.
-    meaning all pages will be built using the absolute permalink behaviour.
-    The switch will still exist until v2.0.
   </p>
 </div>